Merge pull request #2167 from Nagarei/doc/add-directory-structure

doc: deployment.mdにディレクトリ構造を追加
traPtitech · Dec 23, 2023 · bd0d5dd · bd0d5dd
2 parents 86f39f4 + 0d27093
commit bd0d5dd
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/docs/deployment.md b/docs/deployment.md
@@ -333,7 +333,7 @@ Configure the rest of the required components, and connect them in `docker-compo
 - [MariaDB](https://hub.docker.com/_/mariadb)
 - (optional) [Elasticsearch with Sudachi plugin](https://github.com/orgs/traPtitech/packages/container/package/es-with-sudachi) (Sudachi is a Japanese analyzer)
 
-Below is an example `docker-compose.yaml` file, configured to work with the above "Minimal configuration" `config.yml` and "Minimal configuration" `config.js` (placed inside `override` directory), plus `Caddyfile` and `es_jvm.options` below.
+Below is an example `compose.yaml` file, configured to work with the above "Minimal configuration" `config.yml` and "Minimal configuration" `config.js` (placed inside `override` directory), plus `Caddyfile` and `es_jvm.options` below.
 
 ```yaml
 version: '3'
@@ -460,6 +460,19 @@ example.com {
 -Xmx512m
 ```
 
-Run `docker-compose up -d`, and you're ready to go!
+Place the files as follows
+```
+./
+├── Caddyfile
+├── compose.yml
+├── config.yml
+├── es_jvm.options
+└── override
+    └── config.js
+
+1 directory, 5 files
+```
+
+Run `docker compose up -d`, and you're ready to go!
 
 <!-- TODO: For more on actually operating the service, refer to [wiki](https://github.com/traPtitech/traQ/wiki). -->