Installation

Installation

For these installation instructions, I'm assuming that...

• Docker is installed
• Docker can be run without sudo
• docker-compose is installed
• You know the IP address of the computer you'll be running this on
• You know how to do some stuff from the command line and how to edit text files

If you are fuzzy on any of these but want to get this software running, please post something in the Discussions and I'll try to get you going.

Moving on...

1. Create a new directory in your home directory called birdcage
2. Inside birdcage, create a file called docker-compose.yml. Open this file up in a text editor
3. Copy all of the text from the docker-compose file in the repo into your docker-compose.yml file.
4. Replace 192.168.1.75 with the IP address of your computer. There are 3 places.
5. If you are running on an arm64 based computer, read the comments in the docker-compose file to see what changes you need to make.
6. Save the docker-compose.yml file
7. Open up a command line session, if you haven't already, and go into the birdcage directory
8. Execute the command docker-compose up -d

If you just want to be able to access the application from your local network, that's it. The software is installed and running. Time to set your preferences and tell it where to get audio.

If you want to access the application from the internet, you have a little more work to do.

1. Set up your reverse proxy with two names. Let's call them birdcage.example.com and birdcageapi.example.com.
2. Assuming you didn't change any port numbers in the docker-compose file, point birdcage.example.com at your computer's IP address, port 7008 via http. Point birdcageapi.example.com at your computer's IP address, port 7007 via http.
3. Edit the docker-compose.yml file and add http://birdcage.example.com to CORS_ORIGINS. It will end up looking something like this: CORS_ORIGINS: http://youripaddress:7008,http://birdcage.example.com
4. Set API_SERVER_URL to http://birdcageapi.example.com. It will end up looking something like this: API_SERVER_URL: http://birdcageapi.example.com
5. Execute docker-compose down, and then docker-compose up -d again