Skip to content

Commit

Permalink
Update README to include info about Caddy, expose port 3000 in Docker…
Browse files Browse the repository at this point in the history
… cmd

Signed-off-by: Mahad Kalam <[email protected]>
  • Loading branch information
SkyfallWasTaken authored Jun 23, 2024
1 parent 4a6a401 commit a9c3d25
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ You will need:
- Bun
- Node.js (to actually run the project)

Additionally, if you want to run the server, we recommend Docker.
Additionally, if you want to run the server, we recommend:
- Docker
- Caddy

### Building the SMTP server

Expand Down Expand Up @@ -54,12 +56,20 @@ Run it anywhere, e.g. Vercel. Ensure environment variables are set.

##### Backend

This assumes that you are using Docker and Caddy.

Firstly, create a new user for Vortex.

Secondly, [install rootless Docker.](https://docs.docker.com/engine/security/rootless) for the Vortex user.

Finally, use this Docker command:
Then this Docker command:

```bash
docker run --cap-drop=ALL --cap-add=NET_BIND_SERVICE -d -p 25:25 -p 3000:3000 ghcr.io/skyfallwastaken/vortex.email:latest
```

And finally, this Caddy reverse proxy command:

```bash
docker run --cap-drop=ALL --cap-add=NET_BIND_SERVICE -d -p 25:25 ghcr.io/skyfallwastaken/vortex.email:latest
caddy reverse-proxy --from <your api domain> --to :3000
```

0 comments on commit a9c3d25

Please sign in to comment.