57 lines
2.7 KiB
Plaintext
57 lines
2.7 KiB
Plaintext
https://docs.fossorial.io/Getting%20Started/quick-install
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installation Steps
|
|
We also have a short and quick YouTube video showing the install process!
|
|
|
|
1. Downloading and Running the Installer
|
|
Installer binaries for Linux can be found in the Github releases for ARM and AMD64 (x86_64).
|
|
|
|
For example, on amd64 download the installer with either wget or curl and make it executable:
|
|
|
|
wget -O installer "https://github.com/fosrl/pangolin/releases/download/1.0.0-beta.14/installer_linux_amd64" && chmod +x ./installer
|
|
|
|
The downloaded files will be named installer in the current directory.
|
|
|
|
The installer must be run as root. If you're not already root, switch to the root user or use sudo:
|
|
|
|
sudo ./installer
|
|
|
|
The installer will place all files in the current directory. If you want to install Pangolin in a different directory, you can move the installer to that directory and run it there.
|
|
|
|
2. Basic Configuration
|
|
The installer will prompt you for the following basic information:
|
|
|
|
Base Domain Name: Enter your base fully qualified domain name (without any subdomains) Example: example.com
|
|
Dashboard Domain Name: The domain where the application will be hosted. This is used for many things, including generating links. You can run Pangolin on a subdomain or root domain. Example: proxy.example.com
|
|
Let's Encrypt Email: Provide an email address for SSL certificate registration with Lets Encrypt. This should be an email you have access to.
|
|
Tunneling You can choose not to install Gerbil for tunneling support - in this config it will just be a normal reverse proxy. See how to use without tunneling.
|
|
3. Admin User Setup
|
|
You'll need to configure the admin user. This is the first user in the system. You will log in initially with this user.
|
|
|
|
Admin Email: Defaults to admin@yourdomain.com but can be customized
|
|
Admin Password: Must meet these requirements:
|
|
At least 8 characters
|
|
At least one uppercase letter
|
|
At least one lowercase letter
|
|
At least one digit
|
|
At least one special character
|
|
4. Security Settings
|
|
Configure security options:
|
|
|
|
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.
|
|
Organization Creation: Decide if users can create their own organizations (defaults to enabled)
|
|
5. Email Configuration
|
|
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. This is the sender email address that Pangolin will email from. Many times this should be the same as the username. |