Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Pelican Docs

Pelican docs are created with [Docusaurus](https://docusaurus.io).

## Building
Expand All @@ -8,4 +9,4 @@ To test changes locally install the dependencies and run the server using pnpm.
```shell
pnpm i
pnpm run start
```
```
34 changes: 0 additions & 34 deletions docs/about.mdx

This file was deleted.

54 changes: 29 additions & 25 deletions docs/comparison.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
id: comparison
pagination_prev: null
pagination_next: null
---

import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Comparison

Pelican is a fork of [Pterodactyl](https://pterodactyl.io). However, Pelican has many Improvements over it now!
Pelican is a fork of [Pterodactyl](https://pterodactyl.io). However, Pelican has many improvements over it now!

<Admonition type="info">
:::info
Want to see these changes in action? Check out our [Demo](https://demo.pelican.dev)!
</Admonition>
:::

## Roadmap

<Tabs>
<TabItem value="1" label="General">
Expand Down Expand Up @@ -93,24 +95,26 @@ Pelican is a fork of [Pterodactyl](https://pterodactyl.io). However, Pelican has
</TabItem>
</Tabs>

## Comparison with our competitors.
| | Pelican | Pterodactyl | PufferPanel | Crafty Controller | Multicraft | TCAdmin | AMP |
|--------------------------|-----------|-------------|-------------|-----------------------|----------------|---------|----------------|
| File manager | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Scheduled Tasks | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Free and Open Source | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| Multilingual | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Database Management | ✅ | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ |
| OAuth | ✅ | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ |
| Webhooks | ✅ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ |
| Roles & Permissions | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Announcements | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
| Themes | ✅ | ❌ | ✅ | ❌ | ✅ | ✅ | ✅ |
| Plugins | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
| Self update | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
| Captcha Login | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Remote Backups | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |
## Comparison with other software

| | Pelican | Pterodactyl | PufferPanel | Crafty Controller | Multicraft | TCAdmin | AMP |
| -------------------- | ------- | ----------- | ----------- | ----------------- | ---------- | ------- | --- |
| Free and Open Source | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| Multilingual | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Plugins | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
| Themes | ✅ | ❌ | ✅ | ❌ | ✅ | ✅ | ✅ |
| File manager | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Scheduled Tasks | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Database Management | ✅ | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ |
| OAuth | ✅ | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ |
| Webhooks | ✅ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ |
| Roles & Permissions | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Captcha Login | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Remote Backups | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |
| Self update | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
| Announcements | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |

#### Features information

### Features information.
- Plugins can add any features that Pelican doesn't have by default.
- These values are not constantly updated, and competitors may have implemented some of the features marked with a cross in their latest version.
- Plugins can add any feature that Pelican doesn't have by default.
- These values are not constantly updated and the other software may have implemented some of the features marked with a cross in their latest version.
24 changes: 5 additions & 19 deletions docs/glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
id: glossary
pagination_prev: null
pagination_next: null
---

# Glossary

### What is ...?

**Panel** — web application that interfaces with Wings and lets you control your Servers.

**Wings** — application that gives you secure control of your Servers via your Panel.
Expand All @@ -25,19 +24,6 @@ id: glossary
**Yolk** — curated collection of (core) Docker Images that can be used with Pelican's Eggs.


## Basic Example Setup Diagram

```mermaid
flowchart TD
A(Pelican Panel)
A --> B1(Basement Server)
A --> B2(Rented Server)
B1 --> W1(Wings)
B2 --> W2(Wings)
W2 ---> C5(Palworld)
W2 ---> C6(Discord Bot)
W1 ---> C7(FTB Minecraft)
W1 ---> C8(Factorio)
W1 ---> C9(GTA FiveM)
W1 ---> C4(Project Zomboid)
```
#### Basic Example Setup Diagram

![Example banner](/img/docs/example_setup.png)
19 changes: 10 additions & 9 deletions docs/guides/change-panel-domain.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Change Panel Domain

## Webserver & Panel
A brief guide on how to change the Panel domain.

## Web server & Panel

First you need to modify the server name in your web server config.

Expand All @@ -15,19 +16,19 @@ First you need to modify the server name in your web server config.
# Search for "server_name"
```

<Admonition type="info" title="Using HTTPS?">
If you're using HTTPS, remember to also change the SSL paths in the config file to match your new domain and [generate a new certificate](./ssl).
</Admonition>
:::info[Using HTTPS?]
If you're using HTTPS, remember to also change the SSL paths in the config file to match your new domain and [generate a new certificate](ssl).
:::
</TabItem>
<TabItem value="apache" label="Apache">
```sh
sudo nano /etc/apache2/sites-available/pelican.conf
# Search for "ServerName"
```

<Admonition type="info" title="Using HTTPS?">
If you're using HTTPS, remember to also change the SSL paths in the config file to match your new domain and [generate a new certificate](./ssl).
</Admonition>
:::info[Using HTTPS?]
If you're using HTTPS, remember to also change the SSL paths in the config file to match your new domain and [generate a new certificate](ssl).
:::
</TabItem>
<TabItem value="caddy" label="Caddy">
```sh
Expand All @@ -38,7 +39,7 @@ First you need to modify the server name in your web server config.

Next, modify the `APP_URL` in the `.env` file located at `/var/www/pelican` by typing `sudo nano /var/www/pelican/.env`.

Finally, restart your webserver to apply the changes.
Finally, restart your web server to apply the changes.

<Tabs groupId="webserver">
<TabItem value="nginx" label="Nginx">
Expand Down
8 changes: 3 additions & 5 deletions docs/guides/database-hosts.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import Admonition from '@theme/Admonition';

# Database Hosts

Database hosts allow to create per-server databases on the given host.
Expand Down Expand Up @@ -35,15 +33,15 @@ Open `my.cnf`, add text below to the bottom of the file and save it:
bind-address=0.0.0.0
```

Restart MySQL/ MariaDB to apply these changes. This will override the default MySQL configuration, which by default will only accept requests from localhost. Updating this will allow connections on all interfaces, and thus, external connections. Make sure to allow the MySQL port (default 3306) in your firewall.
Restart MySQL/MariaDB to apply these changes. This will override the default MySQL configuration, which by default will only accept requests from localhost. Updating this will allow connections on all interfaces, and thus, external connections. Make sure to allow the MySQL port (default 3306) in your firewall.

## Panel Configuration

In the admin area of the panel, go to "Databases" and click the "New Database Host" button.

<Admonition type="tip">
:::tip
Users will later see the host as their database endpoint. Therefore, you should set it to a public ip or FQDN and not to `localhost` for example.
</Admonition>
:::

Hit "Create" and if everything was entered correctly you should be redirected to the database host list and see your new database host.

Expand Down
46 changes: 25 additions & 21 deletions docs/guides/disk-quotas/ext4-xfs.mdx
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Link from '@docusaurus/Link';

# EXT4 and XFS

This page covers disk quota management for EXT4/XFS.

Both EXT4 and XFS use the built-in quota management services in linux.

<Admonition type="warning">
Please read <Link to="/docs/guides/disk-quotas/about">About Quotas</Link> before continuing
</Admonition>
:::warning
Please read [About Quotas](./) before continuing
:::

## Configure Filesystem

How to format and mount a device for use with quotas

<details>
<summary>I understand the risks and Pelican is not Liable for anything that breaks</summary>

<Admonition type="warning">
:::warning
Enabling quotas for `/` is difficult, as it requires booting a live disk to change.

We do not recommended this!
</Admonition>
:::

These examples use the following:
`/dev/sdb` as the device formatted as EXT4 enabling only project quotas.
Expand All @@ -41,9 +40,9 @@ These examples use the following:
mkfs.ext4 -O quota -E quotatype=prjquota /dev/sdb
```

<Admonition type="warning">
:::warning
You need to update fstab so the disk mounts automatically on boot with quotas enabled.
</Admonition>
:::

## Add to fstab
### get device UUID
Expand All @@ -63,11 +62,11 @@ These examples use the following:
```
For more information on fstab check the [Arch Linux fstab docs](https://wiki.archlinux.org/title/Fstab)

<Admonition type="warning">
:::warning
Depending on the OS you may need to refresh services to be able to mount the partition after updating `fstab`.

It is often easier to reboot and have the disk mount on boot.
</Admonition>
:::
</TabItem>
<TabItem value='Existing EXT4 Filesystem'>
## Update existing partition
Expand All @@ -91,9 +90,9 @@ These examples use the following:
```

## Enable quotas
<Admonition type="warning">
:::warning
This can only be ran on an unmounted disk
</Admonition>
:::
`tune2fs` is used to adjust tunable file system parameters for EXT filesystems
* The `Q` flag is to manage quotas
- `prjquota` is to enable project quotas
Expand All @@ -114,32 +113,35 @@ These examples use the following:
```
For more information on fstab check the [Arch Linux fstab docs](https://wiki.archlinux.org/title/Fstab)

<Admonition type="warning">
:::warning
Depending on the OS you may need to refresh services to be able to mount the partition after updating `fstab`.

It is often easier to reboot and have the disk mount on boot.
</Admonition>
:::
</TabItem>
</Tabs>
</details>

## Advanced EXT4 Quota Management
<Admonition type="danger">

:::danger
The following section is for manual management of quotas.
</Admonition>
:::

<details>
<summary>I understand </summary>
<Admonition type="danger">
:::danger
You should never need to go here, this is your last warning.
</Admonition>
:::
<details>
<summary>I agree and Pelican is not Liable for anything that breaks</summary>

## Manually Manage Quotas

Limits for the servers are managed on a "project" level so they can be assigned per-directory.

### Add A New Project

To add a new project 2 files must be edited.

First is the `projid` file which is formatted where each line is in the `project_name:project_id` format as seen below
Expand All @@ -157,6 +159,7 @@ Second is the `projects` file which is formatted where each line is in the `proj
```

### Set directory attributes

The project attribute must be set on the directory to track quota usage.

The `chattr` command changes attribute for files and directories.
Expand Down Expand Up @@ -198,6 +201,7 @@ setquota -P 235844d3-9258-4846-bb04-bcff209ccf9a 0 10G 0 0 /var/lib/pelican/volu
```

### get quota stats

The `repquota` command will generate a report on the quotas for the specified device or mount path
* The `P` flag will break down the report by project.
- In this case it should be the server UUID that is the project name
Expand All @@ -221,6 +225,6 @@ cdb26bbb-963d-44b1-8353-360243032b1 -- 2G 0G 2G 1g
</details>
</details>

<Admonition type="note">
:::note
TODO: Add documentation specifically for XFS
</Admonition>
:::
Loading