You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-10Lines changed: 18 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,23 @@ The user should have the rights read, write, create and owner.
9
9
10
10

11
11
12
+
## Env variables
13
+
14
+
Those env variables must be defined:
15
+
16
+
- REST_ON_COUCH_URL
17
+
- REST_ON_COUCH_DATABASE
18
+
- REST_ON_COUCH_ACCESS_TOKEN
19
+
- SERVER_PORT
20
+
- PRINTER_PROTOCOL - can be http or tcp, default is `http`
21
+
- DISABLE_MONITOR - Do not update registered printers' status in the database, default is `false`
22
+
- HOST - Server host, e.g. `printers.my-domain.com`, default is `127.0.0.1:<PORT>` - Only needed if you want to expose the swagger documentation of the service.
23
+
- BASE_PATH - Base path for the server, default is `/` - Only needed if you want to expose the swagger documentation of the service.
24
+
12
25
# Development
13
26
27
+
## Run in development
28
+
14
29
Run a dev server which restarts automatically on code changes:
15
30
16
31
```bash
@@ -20,15 +35,8 @@ npm run dev
20
35
The dev server has monitoring disabled so it won't be doing DB operations.
21
36
The docs can be accessed on http://127.0.0.1:7770/documentation
22
37
23
-
## Env variables
38
+
## Publish a new version
24
39
25
-
Those env variables must be defined:
40
+
To publish a new version, create a github release with a new tag `vX.Y.Z` and the package will be automatically published to github's docker registry.
26
41
27
-
- REST_ON_COUCH_URL
28
-
- REST_ON_COUCH_DATABASE
29
-
- REST_ON_COUCH_ACCESS_TOKEN
30
-
- SERVER_PORT
31
-
- PRINTER_PROTOCOL - can be http or tcp, default is `http`
32
-
- DISABLE_MONITOR - Do not update registered printers' status in the database, default is `false`
33
-
- HOST - Server host, e.g. `printers.my-domain.com`, default is `127.0.0.1:<PORT>` - Only needed if you want to expose the swagger documentation of the service.
34
-
- BASE_PATH - Base path for the server, default is `/` - Only needed if you want to expose the swagger documentation of the service.
42
+
Use the "Generate changelog" feature to autofill the description of the release.
0 commit comments