diff --git a/config.yml.sample b/config.yml.sample index a8dbee86fc0..ce6c1e9d70a 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -1,14 +1,23 @@ service: - JWTSecret: "blablaGEHEMIN§)!§" + # This token is used to verify issued JWT tokens. + # Default is a random token which will be generated at each startup of vikunja. + # (This means all already issued tokens will be invalid once you restart vikunja) + JWTSecret: "cei6gaezoosah2bao3ieZohkae5aicah" # The interface on which to run the webserver - interface: ":8080" + interface: ":3456" database: + # Database type to use. Supported types are mysql and sqlite. type: "sqlite" - user: "root" - password: "supersecret" - host: "127.0.0.1" + # Database user which is used to connect to the database. + user: "vikunja" + # Databse password + password: "" + # Databse host + host: "localhost" + # Databse to use database: "vikunja" - showqueries: "true" # When using sqlite, this is the path where to store the data Path: "./vikunja.db" + # Whether to show mysql queries or not. Useful for debugging. + showqueries: "false" \ No newline at end of file diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 00000000000..046878a56ca --- /dev/null +++ b/docs/config.md @@ -0,0 +1,48 @@ +# Configuration options + +You can either use a `config.yml` file in the root directory of vikunja or set all config option with +environment variables. If you have both, the value set in the config file is used. + +Variables are nested in the `config.yml`, these nested variables become `VIKUNJA_FIRST_CHILD` when configuring via +environment variables. So setting + +```bash +export VIKUNJA_FIRST_CHILD=true +``` + +is the same as defining it in a `config.yml` like so: + +```yaml +first: + child: true +``` + +# Default configuration with explanations + +This is the same as the `config.yaml` file you'll find in the root of vikunja. + +```yaml +service: + # This token is used to verify issued JWT tokens. + # Default is a random token which will be generated at each startup of vikunja. + # (This means all already issued tokens will be invalid once you restart vikunja) + JWTSecret: "cei6gaezoosah2bao3ieZohkae5aicah" + # The interface on which to run the webserver + interface: ":3456" + +database: + # Database type to use. Supported types are mysql and sqlite. + type: "sqlite" + # Database user which is used to connect to the database. + user: "vikunja" + # Databse password + password: "" + # Databse host + host: "localhost" + # Databse to use + database: "vikunja" + # When using sqlite, this is the path where to store the data + Path: "./vikunja.db" + # Whether to show mysql queries or not. Useful for debugging. + showqueries: "false" +```