docs: updated configuration page (#808)

go-shiori · Dec 29, 2023 · 55ec418 · 55ec418
1 parent cf7301c
commit 55ec418
Showing 1 changed file with 70 additions and 23 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -2,16 +2,56 @@
 
 <!-- TOC -->
 
-- [Data Directory](#data-directory)
-- [Webroot](#webroot)
+- [Overall Configuration](#overall-configuration)
+  - [Global configuration](#global-configuration)
+  - [HTTP configuration variables](#http-configuration-variables)
+  - [Storage Configuration](#storage-configuration)
+    - [The data Directory](#the-data-directory)
+  - [Database Configuration](#database-configuration)
+    - [MySQL](#mysql)
+    - [PostgreSQL](#postgresql)
+- [Reverse proxies and the webroot path](#reverse-proxies-and-the-webroot-path)
   - [Nginx](#nginx)
-- [Database](#database)
-  - [MySQL](#mysql)
-  - [PostgreSQL](#postgresql)
 
 <!-- /TOC -->
 
-## Data Directory
+## Overall Configuration
+
+Most configuration can be set directly using environment variables or flags. The available flags can be found by running `shiori --help`. The available environment variables are listed below.
+
+### Global configuration
+
+| Environment variable | Default | Required | Description                            |
+| -------------------- | ------- | -------- | -------------------------------------- |
+| `SHIORI_DEVELOPMENT` | `False` | No       | Specifies if the server is in dev mode |
+
+### HTTP configuration variables
+
+| Environment variable                       | Default | Required | Description                                           |
+| ------------------------------------------ | ------- | -------- | ----------------------------------------------------- |
+| `SHIORI_HTTP_ENABLED`                      | True    | No       | Enable HTTP service                                   |
+| `SHIORI_HTTP_PORT`                         | 8080    | No       | Port number for the HTTP service                      |
+| `SHIORI_HTTP_ADDRESS`                      | :       | No       | Address for the HTTP service                          |
+| `SHIORI_HTTP_ROOT_PATH`                    | /       | No       | Root path for the HTTP service                        |
+| `SHIORI_HTTP_ACCESS_LOG`                   | True    | No       | Logging accessibility for HTTP requests               |
+| `SHIORI_HTTP_SERVE_WEB_UI`                 | True    | No       | Serving Web UI via HTTP. Disable serves only the API. |
+| `SHIORI_HTTP_SECRET_KEY`                   |         | **Yes**  | Secret key for HTTP sessions.                         |
+| `SHIORI_HTTP_BODY_LIMIT`                   | 1024    | No       | Limit for request body size                           |
+| `SHIORI_HTTP_READ_TIMEOUT`                 | 10s     | No       | Maximum duration for reading the entire request       |
+| `SHIORI_HTTP_WRITE_TIMEOUT`                | 10s     | No       | Maximum duration before timing out writes             |
+| `SHIORI_HTTP_IDLE_TIMEOUT`                 | 10s     | No       | Maximum amount of time to wait for the next request   |
+| `SHIORI_HTTP_DISABLE_KEEP_ALIVE`           | true    | No       | Disable HTTP keep-alive connections                   |
+| `SHIORI_HTTP_DISABLE_PARSE_MULTIPART_FORM` | true    | No       | Disable pre-parsing of multipart form                 |
+
+### Storage Configuration
+
+The `StorageConfig` struct contains settings related to storage.
+
+| Environment variable | Default       | Required | Description                             |
+| -------------------- | ------------- | -------- | --------------------------------------- |
+| `SHIORI_DIR`         | (current dir) | No       | Directory where Shiori stores its data. |
+
+#### The data Directory
 
 Shiori is designed to work out of the box, but you can change where it stores your bookmarks if you need to.
 
@@ -27,7 +67,30 @@ If you pass the flag `--portable` to Shiori, your data will be stored  in the `s
 
 To specify a custom path, set the `SHIORI_DIR` environment variable.
 
-## Webroot
+### Database Configuration
+
+| Environment variable       | Default | Required | Description                                     |
+| -------------------------- | ------- | -------- | ----------------------------------------------- |
+| `SHIORI_DBMS` (deprecated) | `DBMS`  | No       | Deprecated (Use environment variables for DBMS) |
+| `SHIORI_DATABASE_URL`      | `URL`   | No       | URL for the database (required)                 |
+
+> `SHIORI_DBMS` is deprecated and will be removed in a future release. Please use `SHIORI_DATABASE_URL` instead.
+
+Shiori uses an SQLite3 database stored in the above [data directory by default](#storage-configuration). If you prefer, you can also use MySQL or PostgreSQL database by setting the `SHIORI_DATABASE_URL` environment variable.
+
+#### MySQL
+
+MySQL example: `SHIORI_DATABASE_URL="mysql://username:password@(hostname:port)/database?charset=utf8mb4"`
+
+You can find additional details in [go mysql sql driver documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name).
+
+#### PostgreSQL
+
+PostgreSQL example: `SHIORI_DATABASE_URL="postgres://pqgotest:password@hostname/database?sslmode=verify-full"`
+
+You can find additional details in [go postgres sql driver documentation](https://pkg.go.dev/github.com/lib/pq).
+
+## Reverse proxies and the webroot path
 
 If you want to serve Shiori behind a reverse proxy, you can set the `SHIORI_WEBROOT` environment variable to the path where Shiori is served, e.g. `/shiori`.
 
@@ -46,19 +109,3 @@ location /shiori {
     proxy_set_header X-Real-IP $remote_addr;
 }
 ```
-
-## Database
-
-Shiori uses an SQLite3 database stored in the above data directory by default. If you prefer, you can also use MySQL or PostgreSQL database by setting it in environment variables.
-
-### MySQL
-
-MySQL example: `SHIORI_DATABASE_URL="mysql://username:password@(hostname:port)/database?charset=utf8mb4"`
-
-You can find additional details in [go mysql sql driver documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name).
-
-### PostgreSQL
-
-PostgreSQL example: `SHIORI_DATABASE_URL="postgres://pqgotest:password@hostname/database?sslmode=verify-full"`
-
-You can find additional details in [go postgres sql driver documentation](https://pkg.go.dev/github.com/lib/pq).