Skip to content

Commit fb276b0

Browse files
authored
docs: segregate persistent data from config ones with two distinct folders (#277)
1 parent efb9e06 commit fb276b0

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/user-guide/src/directory-layout-and-volumes.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ rely on every day.
99
Here’s how this layout benefits you:
1010

1111
- ⚙️ **Manage your server configurations your way.**<br/>
12-
Most needs are met with default settings or environment variables. For advanced customization, simply mount override configuration files as explained
13-
in [the dedicated section](configuration-files.md).
12+
Most needs are met with default settings or [environment variables](environment-variables.md). For advanced customization, simply mount override configuration
13+
files as explained in [the dedicated section](configuration-files.md).
1414

1515
- 🌍 **Keep your worlds safe and separate.**<br/>
1616
World saves are stored independently, making imports, backups, and migrations simple.
@@ -29,27 +29,27 @@ This image provides a clean, well-structured directory layout. You can mount vol
2929

3030
The directory structure is as follows:
3131

32-
/data
33-
├── config/ → Configuration overrides
34-
├── worlds/ → World saves (e.g., "world", "world_nether", "world_the_end", etc.)
35-
└── plugins/ → PaperMC plugins (".jar" files and their data)
32+
/config/ → Override configuration files
33+
/data/ → Persistent server data
34+
├── worlds/ → Saved Minecraft worlds (e.g., "world", "world_nether", "world_the_end")
35+
└── plugins/ → PaperMC plugins and their data (JAR files and plugin-specific folders)
3636

3737
### 📌 Directory Details
3838

39-
- **`/data/`**<br/>
40-
This is the root working directory — everything persistent or user-facing lives under it.<br/>
41-
If you want to back up or inspect the full server state, this is the top-level directory to use.<br/>
42-
However, for most use cases, it's better to mount its subdirectories (`config/`, `worlds/`, `plugins/`) individually and/or populate them statically by
43-
building your own OCI image based on this one. This keeps things modular, maintainable, and easier to manage.
44-
45-
- **`/data/config/`**<br/>
39+
- **`/config/`**<br/>
4640
Place configuration override files here.<br/>
4741
This is useful for advanced customization when environment variables aren't enough.<br/>
4842
For best results, define these files statically in your own custom OCI image based on this one.<br/>
4943
More details available [here](configuration-files.md).
5044

45+
- **`/data/`**<br/>
46+
This is the root working directory — everything persistent lives under it.<br/>
47+
If you want to back up or inspect the full server state, this is the top-level directory to use.<br/>
48+
However, for most use cases, it's better to mount its subdirectories (`worlds/`, `plugins/`) individually and/or populate them statically by
49+
building your own OCI image based on this one. This keeps things modular, maintainable, and easier to manage.
50+
5151
- **`/data/worlds/`**<br/>
52-
This directory contains all world saves. <br/>
52+
This directory contains all world saves.<br/>
5353
By default, it includes `world`, `world_nether`, and `world_the_end`, but any custom worlds you configure will also appear here, either in addition to or in
5454
place of the defaults.<br/>
5555
Mount this directory to persist or import your game worlds.

0 commit comments

Comments
 (0)