Skip to content

Commit 98d4f7c

Browse files
committed
Improve documentation of HQ server directory
1 parent 782ac79 commit 98d4f7c

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

docs/deployment/server.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,25 @@ If you use a non-default server directory, make sure to pass the same `--server-
3131
should use the selected HyperQueue server:
3232

3333
```bash
34-
$ hq --server-dir=foo server start
34+
$ hq --server-dir=foo server start &
3535
$ hq --server-dir=foo worker start
3636
```
3737

38+
!!! tip
39+
40+
To avoid having to pass the `--server-dir` parameter to all `hq` commands separately, you can also pass it through the`HQ_SERVER_DIR` environment variable, and export it to share it for all commands in the same terminal session:
41+
```bash
42+
$ export HQ_SERVER_DIR=bar
43+
$ hq server start &
44+
$ hq worker start &
45+
```
46+
3847
!!! important
39-
When you start the server, it will create a new subdirectory in the server directory, which will store the data of the
40-
current running instance. It will also create a symlink `hq-current` which will point to the currently active
41-
subdirectory.
42-
Using this approach, you can start a server using the same server directory multiple times without overwriting data
43-
of the previous runs.
48+
49+
When you start the server, it will create a new subdirectory in the server directory, which will store the data of the current running instance. It will also create a symlink `hq-current` which will point to the currently active
50+
subdirectory.
51+
Using this approach, you can start a server using the same server directory multiple times without overwriting data
52+
of the previous runs.
4453

4554
!!! danger "Server directory access"
4655

0 commit comments

Comments
 (0)