Browse Source

Added basic readme

master
Shyim 7 years ago
parent
commit
0bc6509748
  1. 5
      .env.dist
  2. 22
      README.md

5
.env.dist

@ -29,3 +29,8 @@ JWT_PRIVATE_KEY_PATH=config/jwt/private.pem
JWT_PUBLIC_KEY_PATH=config/jwt/public.pem JWT_PUBLIC_KEY_PATH=config/jwt/public.pem
JWT_PASSPHRASE=a758fddfbc878122f8b37259b8ea14c3 JWT_PASSPHRASE=a758fddfbc878122f8b37259b8ea14c3
###< lexik/jwt-authentication-bundle ### ###< lexik/jwt-authentication-bundle ###
## ReCast Enviroments
NGINX_CONFIG_DIR=/opt/nginx-rtmp/conf/
APP_HOST="http://recast.in"
NGINX_RESTART_COMMAND="systemctl reload nginx-rtmp"

22
README.md

@ -0,0 +1,22 @@
# ReCast
## What is ReCast?
ReCast is a multi platform streaming tool written in PHP and uses nginx RTMP. You can throught your servers to multiple services simultaneously like Twitch, YouTube, Mixer and custom RTMP.
## Installation
* You have to install a nginx server with rtmp support to ```/opt/nginx-rtmp/``` or something else
* Checkout this project and adjust the .env file
* Create the database ```php bin/console doctrine:schema:create```
* Go to ``public/theme``, run ``npm install`` and copy the generated files to public (``cp -R static ..``)
* Create a new crontab entry which runs every minute ```php bin/console recast:cron```
* Create a new user with ```php bin/console recast:create:user```
## Screenshots
![Dashboard](https://i.imgur.com/CJFRqFM.png)
![List Streams](https://i.imgur.com/LGBcyBu.png)
![Add Endpoint](https://i.imgur.com/lGhD6YS.png)
Loading…
Cancel
Save