Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.01 KB

run.md

File metadata and controls

65 lines (46 loc) · 2.01 KB
Raw

Takeout Quick Start

Overview

The takeout run command can be used to quickly setup and run takeout. This process will use command line options, environment variables, and/or simple yaml files to create the required configuration as described in setup.md and start the takeout server.

After using takeout run you can switch to using takeout serve with the created configuration, as described in setup.md.

Use the --setup_only option to only create configuration without starting the server.

Quick Start

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

Now you can use takeout run to setup and start takeout. Below are some example commands. Please see takeout run --help for further details.

$ takeout run --dir /home/takeout --music s3://mybucket/Music --endpoint s3.someprovider.net --region us-west --access_key_id MY_KEY_ID --secret_access_key MY_SECRET_KEY --log /tmp/takeout.log
$ takeout run --dir /home/takeout --music /media/music --movies /media/movies --log /tmp/takeout.log

Note that S3 credentials can be obtained from the following environment variables:

  • AWS_ENDPOINT_URL
  • AWS_DEFAULT_REGION
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

Options can also be stored in a yaml configuration file located here:

  • $HOME/.config/takeout/config.yaml
  • $HOME/.takeout/config.yaml

Supported file options are the same as the command line options, without the leading dashes.