Skip to content

Commit 35cf41c

Browse files
committed
add minimal Docker Compose example to README
1 parent 1f17128 commit 35cf41c

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,5 +138,30 @@ You can test the container using the following command:
138138
docker run --rm -it -v ~/.pwmp-server:/app/data:ro pwmp-server
139139
```
140140

141+
Alternatively, here is a minimal `docker-compose.yml` example:
142+
```yaml
143+
services:
144+
pwmp-server:
145+
image: ghcr.io/pixelweatherproject/pwmp-server:latest
146+
command: "--debug"
147+
logging:
148+
driver: json-file
149+
options:
150+
max-size: "10m"
151+
max-file: "5"
152+
deploy:
153+
resources:
154+
limits:
155+
cpus: 1.0
156+
memory: 1024M
157+
ports:
158+
- "55300:55300/tcp"
159+
volumes:
160+
- ./config.yml:/app/data/config.yml:ro
161+
restart: unless-stopped
162+
```
163+
164+
> **Note**: The above example is minimal and does not include a database container. You will need to set up a separate container for the database and configure the server accordingly.
165+
141166
## Proxies
142167
The server has been tested behind a reverse proxy using Nginx Proxy Manager stream, however, it caused some level of instability. Using reverse proxies is not recommended, as they may interfere with the custom socket optimizations.

0 commit comments

Comments
 (0)