Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Mahad Kalam <[email protected]>
  • Loading branch information
SkyfallWasTaken authored Jun 22, 2024
1 parent 5778369 commit 4a6a401
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ You will need:
- Bun
- Node.js (to actually run the project)

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

### Building the SMTP server

Run:
Expand All @@ -27,7 +29,10 @@ cd frontend
bun run build
```

### Running Vortex in development
## Running Vortex
Ensure you've built everything first.

#### In development

In one terminal, run:
```bash
Expand All @@ -40,3 +45,21 @@ In another, run:
cd frontend
bun dev
```

#### In production

##### Frontend

Run it anywhere, e.g. Vercel. Ensure environment variables are set.

##### Backend

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:

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

0 comments on commit 4a6a401

Please sign in to comment.