-
-
Notifications
You must be signed in to change notification settings - Fork 302
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #367 from thijsvanloef/add-more-docs
Add more documentation
- Loading branch information
Showing
5 changed files
with
48 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 1 | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Kubernetes | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Palworld Directory | ||
|
||
Everything related to the Palworld data is inside the `/palworld` folder inside the container | ||
|
||
## Folder structure | ||
|
||
![Folder Structure](../assets/folder_structure.jpg) | ||
|
||
| Folder | Use | | ||
|------------------------------|-------------------------------------------------------------------| | ||
| palworld | Root folder with all the Palworld Server files | | ||
| backups | Folder where all the backups from the `backup` command are stored | | ||
| Pal/Saved/Config/LinuxServer | Folder with all the .ini configuration files for manual config | | ||
|
||
## Attaching data directory to host filesystem | ||
|
||
The simplest way of attaching the palworld folder to your host system is | ||
to use the example given in the docker-compose.yml file: | ||
|
||
```yml | ||
volumes: | ||
- ./palworld:/palworld/ | ||
``` | ||
This creates a `palworld` folder in the current working directory and mounts the `/palworld` folder. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Known Issues | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Versions | ||
|
||
This page shows how the Docker images tags are versioned. | ||
|
||
## How the versions are structured | ||
|
||
All of the images are tagged according to [Semver](https://semver.org/) except for the `latest` and `dev` images. | ||
|
||
* `latest`: Always the latest release | ||
* `dev`: Latest in progress version (Used only for testing) | ||
* `vX`: Latest Major version | ||
* `vX.X`: Latest Minor version | ||
* `vX.X.X`: Specific Version |