Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Data5tream committed Nov 24, 2023
1 parent b459581 commit 755800b
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,35 @@ Collect and display messages. Either via `formdata` or `json`.

## Environment / configuration variables

| Env name | default value |
|-----------|---------------|
| `DB_HOST` | `localhost` |
| `DB_NAME` | `postgres` |
| `DB_USER` | `postgres` |
| `DB_PASS` | |
| `DB_PORT` | `6543` |
| Env name | default value |
|------------------------|-------------------------|
| `DB_HOST` | `localhost` |
| `DB_NAME` | `postgres` |
| `DB_USER` | `postgres` |
| `DB_PASS` | |
| `DB_PORT` | `5432` |
| `SECRET_KEY` | |
| `DJANGO_DEBUG` | `False` |
| `DJANGO_ALLOWED_HOSTS` | `127.0.0.1,localhost` |
| `CSRF_TRUSTED_ORIGINS` | `http://127.0.0.1:8000` |


## Running

### Prebuild image

Pull the image from GitHub

```shell
podman pull ghcr.io/data5tream/simple-msg-server:latest
```

### Local build

Build the container

```shell
podman build -t simple_msg_server .
podman build -t simple-msg-server .
```

Run the container (you need a running `postgres` database)
Expand All @@ -26,7 +41,7 @@ Run the container (you need a running `postgres` database)
podman run -p 8000:8000 \
-e DB_HOST=host.containers.internal \
-e DB_PASS=password \
simple_msg_server
simple-msg-server
```

## Developing
Expand Down

0 comments on commit 755800b

Please sign in to comment.