Add part of pterodox

This commit is contained in:
Dominika Jadowska 2020-12-11 15:24:17 +01:00
parent ad850c8b70
commit 66eedf4042
No known key found for this signature in database
GPG Key ID: 9EF323937649A25E
4 changed files with 141 additions and 0 deletions

View File

@ -204,6 +204,15 @@ module.exports = {
'/community/about.md', '/community/about.md',
], ],
}, },
{
title: 'Guides',
collapsable: false,
children: [
'/guides/disabling-reCAPTCHA.md',
'/guides/mounts.md',
'/guides/s3-backups.md'
],
},
{ {
title: 'Development & Ops', title: 'Development & Ops',
collapsable: true, collapsable: true,

View File

@ -0,0 +1,58 @@
# Disabling reCAPTCHA
:::warning SECURITY WARNING
It is highly reccomended to keep reCAPTCHA enabled, as reCAPTCHA is a security method that can protect your site from some methods of attack!
Only continue if you intend to re-enable reCAPTCHA after fixing whatever issue you may have!
:::
## Disabling via .env
In order to disable reCAPTCHA using this method, you need to find and edit your `.env` file, It is usually located at `/var/www/pterodactyl/.env`
:::tip Hidden Files
In linux, files starting with a `.` are considered to be hidden, so most FTP software may not show it by default. You can see the file by using `ls -a`
:::
First, lets back up the `.env` file. If you are not already, now is a good time to make sure you are in the `/var/www/pterodactyl` directory
```bash
cp .env .env.bkp
```
You can now edit the `.env` file using your favorite editor to set the fields below
```bash
# Ignores database settings
APP_ENVIRONMENT_ONLY=true
# Disable reCAPTCHA. You may need to add this to the end of your file.
RECAPTCHA_ENABLED=false
```
### Restoring Functionality
After fixing your issue, it is **Highly** recommended to re-enable reCAPTCHA in order to protect your panel. This is achived by restoring the previous settings in the `.env` as follows
```bash
# Allows updating panel configuration via the panel (optional)
APP_ENVIRONMENT_ONLY=false
# Ensures reCAPTCHA is enabled
RECAPTCHA_ENABLED=true
```
## Editing your database
:::danger DANGEROUS: Not Recommended
While faster, this method should only be used if the `.env` method fails or you know what you are doing! We do not take responsibility if you manage to corrupt your database using this method!
:::
```sql
mysql -u root -p
USE panel;
UPDATE settings SET value = 'false' WHERE 'key' = 'settings::recaptcha:enabled';
```
If the command returns with `Query OK, 0 rows affected (0.000 sec)` you need to use the `.env` method to disable reCAPTCHA
Again, it is **Highly** recommended to re-enable reCAPTCHA after you fix your issue, whether through the `.env` above or in the panel!

51
guides/mounts.md Normal file
View File

@ -0,0 +1,51 @@
# Using Mounts
A mount in pterodactyl follows similar principles to a docker mount. Pterodactyl already uses the `/home/container` mount thus it or any of it's sub directories can not be used as a different or nested mount.
## Wings Configuration
In order to use a mount you need to permit wings to use the selected mount path, this is done by editing mounts in `/etc/pterodactyl/config.yml`
```yml
allowed_mounts:
- /example
```
where `example` is a path on your system, Mounts allow anything within that path to be used as a mount.
## Panel Configuration
In the pterodactyl panel you need to create and assign a mount.
### Creating a mount
:::tip Mount Paths
Mounts can not use any path or subpath of `/home/container` due to docker limitations
:::
1. In the admin panel go to **Mounts**
2. Use the create mount option
3. Fill in the details as required
- **Name**: Name for your mount
- **Description**:Description for your mount
- **Source**:File path on your system to where mount files should be stored
- **Target**: File path where the mount will be placed inside of your server, Can NOT be `/home/container`
- **Read Only**: Whether to allow servers to write to the directory
- **User Mountable**: Whether to allow users to self mount this mount
4. After creating the mount you are required to add **Eggs** and **Nodes** that this mount may be used on
:::danger Mount Logic
Mounts do not share data across servers, They only can share paths not files!
:::
### Assigning a mount
1. In the admin panel go to the server you would like to use a mount with
2. Go to the mounts page
3. Click the button
4. Restart the server
The files of the mount should become available in the target path in the container.
:::warning Disclaimer
Mounts do not show in the panel's file manager, nor will they be accessible via sFTP
:::

23
guides/s3-backups.md Normal file
View File

@ -0,0 +1,23 @@
# Using S3 Backups
<!--Might need to expand a bit more on here-->
To use S3 backups you may use the following `.env` variables
```bash
# Sets your panel to use s3 for backups
APP_BACKUP_DRIVER=s3
# Info to actually use s3
AWS_DEFAULT_REGION=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_BACKUPS_BUCKET=
AWS_ENDPOINT=
# Dunno what these are but maybe you do?
AWS_USE_PATH_STYLE_ENDPOINT=false
AWS_BACKUPS_USE_ACCELERATE=false
```