diff --git a/docusaurus/docs/advanced/kubernetes.md b/docusaurus/docs/advanced/kubernetes.md index fd8214491..9f8ece499 100644 --- a/docusaurus/docs/advanced/kubernetes.md +++ b/docusaurus/docs/advanced/kubernetes.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 --- # Kubernetes diff --git a/docusaurus/docs/advanced/palworld-directory.md b/docusaurus/docs/advanced/palworld-directory.md new file mode 100644 index 000000000..39c2e7382 --- /dev/null +++ b/docusaurus/docs/advanced/palworld-directory.md @@ -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. diff --git a/docusaurus/docs/assets/folder_structure.jpg b/docusaurus/docs/assets/folder_structure.jpg new file mode 100644 index 000000000..dd81d8041 Binary files /dev/null and b/docusaurus/docs/assets/folder_structure.jpg differ diff --git a/docusaurus/docs/known-issues/known-issues.md b/docusaurus/docs/known-issues/known-issues.md index 639bbf622..36c7213db 100644 --- a/docusaurus/docs/known-issues/known-issues.md +++ b/docusaurus/docs/known-issues/known-issues.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Known Issues diff --git a/docusaurus/docs/versions/versions.md b/docusaurus/docs/versions/versions.md new file mode 100644 index 000000000..5769899df --- /dev/null +++ b/docusaurus/docs/versions/versions.md @@ -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