Skip to content

Commit 0eae1ad

Browse files
committed
fix: release 3.0
1 parent a0c7bec commit 0eae1ad

2 files changed

Lines changed: 5 additions & 12 deletions

File tree

docs/config.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,19 @@
44
import {data as envExample} from '../config.data.ts'
55
</script>
66

7-
::: details 3.x Config
8-
97
Gotify 3.x is configured through environment variables, which can be loaded from
108
an env file. [`gotify-server.env.example`](https://raw.githubusercontent.com/gotify/server/refs/heads/master/gotify-server.env.example)
119

1210
<div v-html="envExample"></div>
1311

14-
:::
12+
---
1513

1614
::: details 2.x Config
1715

1816
gotify/server can be configured per config file and environment variables.
1917
When using docker it is recommended to use environment variables.
2018

21-
## Config File
19+
### Config File
2220

2321
gotify/server looks in the following paths for config files
2422

@@ -114,7 +112,7 @@ $ wget -O config.yml https://raw.githubusercontent.com/gotify/server/master/conf
114112

115113
**Note: the example config doesn't only contain default values.**
116114

117-
## Database
115+
### Database
118116

119117
| Dialect | Connection |
120118
| :------: | :--------------------------------------------------------------------------------: |
@@ -127,7 +125,7 @@ See [#90](https://github.com/gotify/server/issues/90).
127125

128126
> For `mysql` and `postgres`: Make sure the defined database exists and the user has sufficient permissions.
129127
130-
## Environment Variables
128+
### Environment Variables
131129

132130
Strings in list or map environment settings (f.ex. `GOTIFY_SERVER_RESPONSEHEADERS` and `GOTIFY_SERVER_SSL_LETSENCRYPT_HOSTS`) need to be escaped.
133131
[A list of reserved characters and how to escape them.](https://stackoverflow.com/a/22235064/4244993)

docs/migrate-to-3.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
# Migrate to 3.x
22

3-
> [!WARNING]
4-
> Gotify 3 isn't released yet.
5-
6-
---
7-
83
- The `config.yml` file is no longer supported, convert it to the new env format
94
with [`migrate-config`](#migrating-your-config).
105
- If you set list or map environment variables, their syntax changed, see
@@ -42,7 +37,7 @@ $ gotify-server migrate-config config.yml > gotify-server.env
4237
With Docker:
4338

4439
```bash
45-
$ docker run --rm -v "$(pwd)/config.yml:/app/config.yml" gotify/server:master \
40+
$ docker run --rm -v "$(pwd)/config.yml:/app/config.yml" gotify/server:3.0.0 \
4641
migrate-config config.yml > gotify-server.env
4742
```
4843

0 commit comments

Comments
 (0)