Skip to content

Commit

Permalink
Merge pull request #367 from thijsvanloef/add-more-docs
Browse files Browse the repository at this point in the history
Add more documentation
  • Loading branch information
thijsvanloef authored Feb 11, 2024
2 parents 885d7bc + 40971cc commit aed931b
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docusaurus/docs/advanced/kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 2
---

# Kubernetes
Expand Down
29 changes: 29 additions & 0 deletions docusaurus/docs/advanced/palworld-directory.md
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.
Binary file added docusaurus/docs/assets/folder_structure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docusaurus/docs/known-issues/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Known Issues
Expand Down
17 changes: 17 additions & 0 deletions docusaurus/docs/versions/versions.md
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

0 comments on commit aed931b

Please sign in to comment.