docs: add self hosting instructions
This commit is contained in:
parent
79540a6830
commit
c1032c9afb
33
README.md
33
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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user