setup.md

Takeout Setup

Overview

This setup assumes a Linux system is being used. Takeout is written in Go, so most other systems will also work fine. Please adjust commands below as needed. You can setup on a virtual private server (VPS) in the cloud such as EC2, GCE, Digital Ocean, Linode, or use your spiffy computer at home.

For cloud storage, you need to have media stored in an S3 bucket somewhere. Some common services are AWS S3, Wasabi, Backblaze, and Minio. And if you're using that spiffy home computer, you can also install Minio at home and make your local media available via S3 to your home network.

Takeout can also access local media files without needing S3. This may be your best option for home media access. Using S3 in the cloud is recommended if you want to have your media securely available wherever you go.

Please see bucket.md for further details on how you should organize your media is S3 or locally. rclone is an excellent tool to manage S3 buckets from the command line. Once that's all done, proceed with the steps below.

Steps

Download and install Go from https://go.dev/ as needed. Run the following command to ensure Go is correctly installed. You should have Go 1.22 or higher.

$ go version

Download and build the Takeout server from Github.

$ go install github.com/takeoutfm/takeout/cmd/takeout@latest

This will build & install Takeout in $GOPATH/bin. Don't worry if you don't have a GOPATH environment variable defined, Go will default to your home directory (~/go/bin). Ensure that $GOPATH/bin is in your command path. You should see a Takeout version displayed.

$ takeout version

Create the takeout directory. This is the base directory where config files, databases, and logs will be stored.

$ TAKEOUT_HOME=~/takeout
$ mkdir ${TAKEOUT_HOME}

Create a media sub-directory to store bucket specific configuration and databases. Change "mymedia" to whatever name you like (here and below). Your media isn't stored here, just related config files and databases.

$ mkdir ${TAKEOUT_HOME}/mymedia

Copy sample start script

$ cp start.sh ${TAKEOUT_HOME}
$ chmod 755 ${TAKEOUT_HOME}/start.sh

Copy sample config files

$ cp doc/takeout.yaml ${TAKEOUT_HOME}
$ cp doc/config.yaml ${TAKEOUT_HOME}/mymedia

Sync your media. This may take multiple hours depending on the amount of media files. Repeat the sync command for other media directories you may have created. The Takeout server will sync media periodically as well.

$ cd ${TAKEOUT_HOME}/mymedia
$ takeout sync

You may encounter sync errors like the following:

2022/08/11 11:08:41 artist not found: Billy F Gibbons
2022/08/11 11:08:41 track release not found: Billy F Gibbons/Hardware/12/1

In this example the artist "Billy F Gibbons" was used to tag and store the media, however, MusicBrainz knows this artist as "Billy Gibbons". You can fix this with RewriteRules or adjust your media file names and/or directory names. Troubleshooting this stuff may be difficult so ask for help as needed.

Create your first user. Change the example user "ozzy" and password. Please use a strong password to protect access to your media. Note that "mymedia" must match the Takeout sub-directory name used above. The idea here is that there can be multiple users and users can use the same or different buckets of media. Indie for Dad, scary movies for Mom, and some emo for the teenager.

$ cd ${TAKEOUT_HOME}
$ takeout user --add --user="ozzy" --pass="changeme" --media="mymedia"

Setup a secure TLS front-end to the Takeout server. Nginx is a great option. Let's Encrypt) can be used to get a free TLS certificate. An Nginx config example would be:

server {
    listen 0.0.0.0:80;
    server_name myserver.org;
    return 301 https://$host$request_uri;
}

upstream myapp {
    server 127.0.0.1:3000;
    keepalive 8;
}

server {
    listen 443 ssl http2;
    server_name myserver.org;

    ssl_certificate /etc/letsencrypt/live/myserver.org/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/myserver.org/privkey.pem;
    ssl_trusted_certificate /etc/letsencrypt/live/myserver.org/chain.pem;

    access_log /var/log/nginx/myserver.org.log;

    location / {
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header Host $http_host;
      proxy_set_header X-NginX-Proxy true;
      proxy_pass http://myapp/;
      proxy_redirect off;
    }
}

Create some radio stations.

$ cd ${TAKEOUT_HOME}/mymedia
$ takeout radio

Start the server.

$ cd ${TAKEOUT_HOME}
$ ./start.sh