Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ngrie committed Nov 14, 2021
1 parent a02eaf7 commit ce0365c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,25 @@ RTMPie is a management web interface for the RTMP NGINX module.

## Installation

The official installation method is using [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/).
The official installation method is using [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/). Please install both tools according to their documentation.

A detailed guide will be coming soon. For now you can refer to [this compose file](docker/docker-compose.prod.yaml) to create a setup yourself.
If you want to make RTMPie available under a publicly accessible domain (e.g. demo.rtmpie.de), make sure to set up the necessary DNS settings before continuing.

When Docker is installed, proceed with installing RTMPie:
```bash
mkdir /opt/rtmpie
cd /opt/rtmpie

# Download the small installer script
wget https://raw.githubusercontent.com/ngrie/rtmpie/main/setup.sh
bash setup.sh # Answer the questions

# Run the docker setup
docker-compose pull
docker-compose up -d
```

The webinteface will be available after a few seconds and you can login using the default credentials `admin / admin`.

## Credits

Expand Down
4 changes: 4 additions & 0 deletions docker/docker-compose.prod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ version: '3.4'
services:
php:
image: ghcr.io/ngrie/rtmpie/php:latest
restart: unless-stopped
environment:
APP_SECRET: ${RTMPIE_APP_SECRET}
DATABASE_URL: mysql://root:${RTMPIE_DATABASE_PASSWORD}@database:3306/rtmpie?serverVersion=mariadb-10.4.12
Expand All @@ -11,6 +12,7 @@ services:

caddy:
image: ghcr.io/ngrie/rtmpie/caddy:latest
restart: unless-stopped
ports:
- 80:80
- 443:443
Expand All @@ -24,11 +26,13 @@ services:

rtmp:
image: ghcr.io/ngrie/rtmpie/rtmp:latest
restart: unless-stopped
ports:
- 1935:1935

database:
image: mariadb:10.4
restart: unless-stopped
environment:
MYSQL_ROOT_PASSWORD: ${RTMPIE_DATABASE_PASSWORD}
MYSQL_DATABASE: rtmpie
Expand Down

0 comments on commit ce0365c

Please sign in to comment.