#Standalone Installation

Our Standalone Version of OpenOverlay is the easiest and most effective way to deploy your Overlay and Bot Service for your twitch Channel.

The Standalone Version comes with everything you need, like a Websocket and Sail (Docker compose) configuration for a bot container.

#Installation

1. Clone OpenOverlay Standalone

   git clone https://github.com/redbeed/OpenOverlay-Standalone.git
   

2. Run composer install

   composer install --ignore-platform-reqs
   

3. Copy .env.example to .env

   cp .env.example .env
   

4. Fill PUSHER_APP_SECRET with a random secret hash, in your generated .env file.

   You also could change PUSHER_APP_KEY and PUSHER_APP_ID.

5. Add a custom password for DB_PASSWORD= and DB_ROOT_PASSWORD= in the .env

6. Start docker/sail

   ./vendor/bin/sail up
   

   Laravel Sail is supported on macOS, Linux, and Windows (via WSL2). (Sail Documentation)

   Make sure before running sail that you installed and started Docker and docker-compose.

7. Generate APP Key

   ./vendor/bin/sail artisan key:generate
   

8. Generate Twitch Communication Secret

   ./vendor/bin/sail artisan overlay:secret
   

9. Migrate Database

   ./vendor/bin/sail artisan migrate
   

10. Create your account

    http://localhost/register
    

11. Follow steps on your website