mirror of
https://github.com/fosrl/docs.git
synced 2025-05-12 21:30:43 +01:00
Sidebar layout and start install / update docs
This commit is contained in:
parent
aac30e2e20
commit
55ce4f8213
9 changed files with 37 additions and 71 deletions
3
packages/docusaurus/docs/01-overview.md
Normal file
3
packages/docusaurus/docs/01-overview.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Overview
|
||||
|
||||

|
|
@ -1,14 +1,25 @@
|
|||
# Quick Installation Guide
|
||||
# Install
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Linux system with root access
|
||||
- A Linux system with root access and a public IP address
|
||||
- A domain name pointed to your server's IP address
|
||||
- An email address for Let's Encrypt certificate registration
|
||||
- (Optionally) a SMTP server
|
||||
|
||||
## Installation Steps
|
||||
|
||||
### 1. Running the Installer
|
||||
### 1. Downloading and Running the Installer
|
||||
|
||||
Download the installer with either wget or curl:
|
||||
|
||||
```bash
|
||||
wget -O installer "https://github.com/fosrl/pangolin/releases/download/v1.0.0-beta.1/installer"
|
||||
```
|
||||
|
||||
```bash
|
||||
curl -L -o installer "https://github.com/fosrl/pangolin/releases/download/v1.0.0-beta.1/installer"
|
||||
```
|
||||
|
||||
The installer must be run as root. If you're not already root, switch to the root user or use sudo:
|
||||
|
||||
|
@ -20,12 +31,12 @@ sudo ./installer
|
|||
|
||||
The installer will prompt you for the following basic information:
|
||||
|
||||
1. **Domain Name**: Enter your fully qualified domain name
|
||||
2. **Let's Encrypt Email**: Provide an email address for SSL certificate registration
|
||||
1. **Domain Name**: Enter your fully qualified domain name that you have pointing to this instance
|
||||
2. **Let's Encrypt Email**: Provide an email address for SSL certificate registration with Lets Encrypt. This should be an email you have access to.
|
||||
|
||||
### 3. Admin User Setup
|
||||
|
||||
You'll need to configure the admin user:
|
||||
You'll need to configure the admin user. This is the first user in the system. You will log in initially with this user.
|
||||
|
||||
1. **Admin Email**: Defaults to `admin@yourdomain` but can be customized
|
||||
2. **Admin Password**: Must meet these requirements:
|
||||
|
@ -38,19 +49,19 @@ You'll need to configure the admin user:
|
|||
|
||||
Configure security options:
|
||||
|
||||
1. **Signup Without Invite**: Choose whether to disable user registration without invites (defaults to disabled)
|
||||
1. **Signup Without Invite**: Choose whether to disable user registration without invites (defaults to disabled). This removes the "Sign Up" button on the login form and is recommended for private deployments.
|
||||
2. **Organization Creation**: Decide if users can create their own organizations (defaults to enabled)
|
||||
|
||||
### 5. Email Configuration
|
||||
|
||||
Decide whether to enable email functionality:
|
||||
Decide whether to enable email functionality. This allows Pangolin to send transactional emails like OTP or email verification requests.
|
||||
|
||||
If enabled, you'll need to provide:
|
||||
- SMTP host
|
||||
- SMTP port (defaults to 587)
|
||||
- SMTP username
|
||||
- SMTP password
|
||||
- No-reply email address
|
||||
- No-reply email address. This is the sender email address that Pangolin will email from. Many times this should be the same as the username.
|
||||
|
||||
### 6. Docker Installation
|
||||
|
||||
|
@ -86,23 +97,9 @@ After successful installation:
|
|||
|
||||
1. The system will be accessible at your configured domain
|
||||
2. You can log in using the admin email and password you provided
|
||||
3. Configuration files will be located in the `config/` directory
|
||||
4. Docker Compose file will be in the root directory as `docker-compose.yml`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
1. **Permission Denied**: Make sure you're running the installer as root
|
||||
2. **Docker Installation Fails**: Check your internet connection and system compatibility
|
||||
3. **Container Startup Fails**: Verify that:
|
||||
- All required ports are available
|
||||
- Docker service is running
|
||||
- Your system has enough resources
|
||||
|
||||
## Notes
|
||||
|
||||
- The installer checks for an existing configuration and won't overwrite it if found
|
||||
- All inputs have validation to ensure proper formatting
|
||||
- Docker installation is optional if already present
|
||||
- The system uses Docker Compose for container orchestration
|
||||
<!-- - You can pull the latest and rerun the install script to update the containers! -->
|
|
@ -0,0 +1,5 @@
|
|||
# Setup
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Followed the setup steps and have a Pangolin server running with Gerbil, Traefik and Badger.
|
1
packages/docusaurus/docs/03-Pangolin/overview.md
Normal file
1
packages/docusaurus/docs/03-Pangolin/overview.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Overview
|
1
packages/docusaurus/docs/04-Badger/overview.md
Normal file
1
packages/docusaurus/docs/04-Badger/overview.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Overview
|
1
packages/docusaurus/docs/05-Gerbil/overview.md
Normal file
1
packages/docusaurus/docs/05-Gerbil/overview.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Overview
|
1
packages/docusaurus/docs/06-Newt/overview.md
Normal file
1
packages/docusaurus/docs/06-Newt/overview.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Overview
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Tutorial Intro
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Get started by **creating a new site**.
|
||||
|
||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||
|
||||
### What you'll need
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
|
||||
## Generate a new site
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**.
|
||||
|
||||
The classic template will automatically be added to your project after you run the command:
|
||||
|
||||
```bash
|
||||
npm init docusaurus@latest my-website classic
|
||||
```
|
||||
|
||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||
|
||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||
|
||||
## Start your site
|
||||
|
||||
Run the development server:
|
||||
|
||||
```bash
|
||||
cd my-website
|
||||
npm run start
|
||||
```
|
||||
|
||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||
|
||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||
|
||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 156 KiB |
Loading…
Reference in a new issue