diff --git a/README.md b/README.md index 46a3792..95442a0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,39 @@ Give your server's hostname a proper home on the Internet. +## Self-Host + +1. **Clone our Repo** + + ```bash + git clone https://git.pontusmail.org/librecloud/im-a-server + ``` + +2. **Install dependencies** + + ```bash + bun install + npm install # or use npm + ``` + +3. Now, you must choose whether to deploy with Docker or start a development server. + +### Start Development Server + +```bash +bun dev +``` + +A server will now be available on port 3000. + +### Deploy with Docker + +You can edit the default `docker-compose.yml` file to your liking, then execute the following: + +```bash +docker compose up -d --build # builds and runs in background +``` + ## Configuration Configuration is done through the `.tsx` files in `src/app/config`. Don't worry, even if you haven't used Next.js before, it's dead simple to configure.