fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-12 21:30:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
miloschwartz 2025-02-23 17:36:05 -05:00
parent 4241a2706a
commit 89702702c2
No known key found for this signature in database
3 changed files with 29 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
packages/docusaurus/docs/02-Getting Started/01-choosing-a-vps.md
View file

@ -2,40 +2,40 @@
Our stack is lightweight and efficient, so you don’t need a high-powered server to get started. A minimal VPS instance with **1 vCPU, 1GB RAM, and 8GB SSD** will perform perfectly well for most use cases. In some cases, you may be able to get away with even less. Our stack is lightweight and efficient, so you don’t need a high-powered server to get started. A minimal VPS instance with **1 vCPU, 1GB RAM, and 8GB SSD** will perform perfectly well for most use cases. In some cases, you may be able to get away with even less.
## Recommended VPS Providers ## [Rack Nerd](https://my.racknerd.com/aff.php?aff=13788)
Here’s a list of popular VPS platforms in no particular order, all offering low-cost options that fit the recommended specs: Many of our users have had a great experience with [RackNerd](https://my.racknerd.com/aff.php?aff=13788). Depending on promotions, you can likely get a VPS with **1 vCPU, 1GB RAM, and ~20GB SSD for just around $12/year**. That's a great deal!
1. **[Amazon EC2](https://instances.vantage.sh/)** We are part of the [RackNerd](https://my.racknerd.com/aff.php?aff=13788) affiliate program, so if you sign up using [our link](https://my.racknerd.com/aff.php?aff=13788), we receive a small commission which helps us maintain the project and keep it free for everyone.
- Pricing: Starts around $8.50/month for 1 vCPU, 1GB RAM, and 8GB SSD. ## Other Providers
2. **[DigitalOcean](https://www.digitalocean.com/pricing/droplets)** Here’s a list of other popular VPS platforms in no particular order:
- Pricing: Starts around $6/month for 1 vCPU, 1GB RAM, and 25GB SSD. **[Amazon EC2](https://instances.vantage.sh/)**
3. **[Vultr](https://www.vultr.com/pricing)** - Pricing: Starts around $8.50/month for 1 vCPU, 1GB RAM, and 8GB SSD.
- Pricing: Starts around $5/month for 1 vCPU, 1GB RAM, and 25GB SSD. **[DigitalOcean](https://www.digitalocean.com/pricing/droplets)**
4. **[Linode](https://www.linode.com/pricing/)** - Pricing: Starts around $6/month for 1 vCPU, 1GB RAM, and 25GB SSD.
- Pricing: Starts around $5/month for 1 vCPU, 1GB RAM, and 25GB SSD. **[Vultr](https://www.vultr.com/pricing)**
5. **[Hetzner Cloud](https://www.hetzner.com/cloud)** - Pricing: Starts around $5/month for 1 vCPU, 1GB RAM, and 25GB SSD.
- Pricing: Starts around $4.59/month for 2 vCPU, 4GB RAM, and 40GB SSD. **[Linode](https://www.linode.com/pricing/)**
6. **[UpCloud](https://upcloud.com/pricing/)** - Pricing: Starts around $5/month for 1 vCPU, 1GB RAM, and 25GB SSD.
- Pricing: Starts around $3.30/month for 1 vCPU, 1GB RAM, and 10GB SSD. **[Hetzner Cloud](https://www.hetzner.com/cloud)**
7. **[OVHcloud](https://www.ovhcloud.com/en/vps/)** - Pricing: Starts around $4.59/month for 2 vCPU, 4GB RAM, and 40GB SSD.
- Pricing: Starts around $5.50/month for 2 vCPU, 2GB RAM, and 40GB SSD. **[UpCloud](https://upcloud.com/pricing/)**
--- - Pricing: Starts around $3.30/month for 1 vCPU, 1GB RAM, and 10GB SSD.
## General Pricing Overview **[OVHcloud](https://www.ovhcloud.com/en/vps/)**
You can find VPS instances starting from **$3 to $6 per month**, depending on the provider and location. While all of the above options are suitable, we recommend choosing a provider with servers close to your user base for optimal performance. - Pricing: Starts around $5.50/month for 2 vCPU, 2GB RAM, and 40GB SSD.

15
packages/docusaurus/docs/02-Getting Started/03-quick-install.md
View file

@ -12,6 +12,10 @@ import WgetQuickInstaller from "@site/src/components/WgetQuickInstaller";
- An email address for Let's Encrypt certificate registration - An email address for Let's Encrypt certificate registration
- (Optionally) a SMTP server - (Optionally) a SMTP server
## Using a VPS
If you need a VPS to run Pangolin, [RackNerd](https://my.racknerd.com/aff.php?aff=13788) is a great option, and often has generous promotions. More options can be found in our [VPS guide](./01-choosing-a-vps.md).
## Installation Steps ## Installation Steps
We also have a short and quick [YouTube video](https://youtu.be/W0uVLjTyAn8) showing the install process! We also have a short and quick [YouTube video](https://youtu.be/W0uVLjTyAn8) showing the install process!
@ -36,7 +40,7 @@ The installer will place all files in the current directory. If you want to inst
### 2. Basic Configuration ### 2. Basic Configuration
The installer will prompt you for the following basic information: The installer will prompt you for the following basic information. For example:
1. **Base Domain Name**: Enter your base fully qualified domain name (without any subdomains) Example: `example.com` 1. **Base Domain Name**: Enter your base fully qualified domain name (without any subdomains) Example: `example.com`
2. **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` 2. **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`
@ -57,7 +61,7 @@ You'll need to configure the admin user. This is the first user in the system. Y
### 4. Security Settings ### 4. Security Settings
Configure security options: It will ask you to configure some basic security options. For example:
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. 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) 2. **Organization Creation**: Decide if users can create their own organizations (defaults to enabled)
@ -97,11 +101,7 @@ Supported distributions:
After configuration, the installer will: After configuration, the installer will:
1. Pull the necessary Docker containers 1. Pull the necessary Docker containers
2. Create required directories: 2. Create required directories
- `config/`
- `config/letsencrypt/`
- `config/db/`
- `config/logs/`
3. Generate configuration files 3. Generate configuration files
4. Start the containers using Docker Compose 4. Start the containers using Docker Compose
@ -116,4 +116,3 @@ After successful installation:
- The installer checks for an existing configuration and won't overwrite it if found - The installer checks for an existing configuration and won't overwrite it if found
- Docker installation is optional if already present - Docker installation is optional if already present
<!-- - You can pull the latest and rerun the install script to update the containers! -->

6
packages/docusaurus/docs/07-roadmap.md
View file

@ -52,7 +52,7 @@ Are you experienced with authentication procedures and best practices? We would
### UI/UX Improvements ### UI/UX Improvements
- [ ] Improved sidebar and navigation - [ ] Improved sidebar and navigation
- [ ] Add refresh buttons to tables - [ ] Add refresh buttons to tables
- [ ] Table page size selector - [x] Table page size selector
- [ ] Loading skeletons - [ ] Loading skeletons
- [ ] iFrame dashboard to launch apps (similar to Organizr or other dashboards) - [ ] iFrame dashboard to launch apps (similar to Organizr or other dashboards)
- [ ] Pin apps to sidebar on dashboard - [ ] Pin apps to sidebar on dashboard
@ -72,8 +72,8 @@ Are you experienced with authentication procedures and best practices? We would
- [x] UDP/TCP targets if people want to expose custom apis or other traffic themselves. - [x] UDP/TCP targets if people want to expose custom apis or other traffic themselves.
- [x] Sites that do not require newt or wireguard so you can traefik to anything - [x] Sites that do not require newt or wireguard so you can traefik to anything
- [ ] Automatically create DNS records if provided with access to DNS provider (like Cloudflare API key) - [ ] Automatically create DNS records if provided with access to DNS provider (like Cloudflare API key)
- [ ] Support tailscale as an exit node - [ ] Support Tailscale as an exit node
### SAAS ### SAAS
We intend at some point to provide Pangolin in a hosted offering with a healthy free tier and pricing competitive to generally available cloud VPS services. This way users who would like to use Pangolin - but don't want to manage their own VPS - can do so and help to fund future development. We intend at some point to provide Pangolin in a hosted offering with a healthy free tier and pricing competitive to generally available cloud VPS services. This way users who would like to use Pangolin - but don't want to manage their own VPS - can do so and help to fund future development.