librecloud/im-a-server
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add self hosting instructions

Browse Source
This commit is contained in:
Aidan 2025-04-23 12:14:15 -04:00
parent 79540a6830
commit c1032c9afb
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -2,6 +2,39 @@
Give your server's hostname a proper home on the Internet. 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
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. 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.