Skip to content

Commit 6992c58

Browse files
committed
Update README
1 parent 90aacf2 commit 6992c58

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,24 @@ docker compose version
2525
# Check Taskfile CLI installation
2626
task --version
2727
```
28+
29+
## Create the deploy-user
30+
Files inside the `os2display-api-service` container are owned by a user with UID 1042 and GID 1042. To prevent permission issues with bind mounts (the `media` and `jwt` volumes), it’s best to install the application using a user with the same UID and GID.
31+
32+
To set this up on your server, create a new user (for example, `deploy`). You can choose a different username if you prefer, but make sure to assign UID and GID 1042.
33+
34+
Here’s how to create the user:
35+
36+
```bash
37+
# Create group and user with UID/GID 1042
38+
sudo groupadd -g 1042 deploy
39+
sudo useradd -u 1042 -g 1042 -m -s /bin/bash deploy
40+
sudo passwd deploy
41+
42+
# Add the user to the docker group
43+
sudo usermod -aG docker deploy
44+
```
45+
2846
## Secure Mode Requirement
2947

3048
This project can only run in secure mode using HTTPS (port 443). To ensure proper functionality, you must provide a valid domain name and an SSL certificate.

0 commit comments

Comments
 (0)