takeout

package module

v0.26.2 Latest Latest Go to latest Published: Nov 12, 2025 License: AGPL-3.0 Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/takeoutfm/takeout

Links

Open Source Insights

README ¶

TakeoutFM

TakeoutFM is a self-hosted free software media system. Enjoy your media on your phone, desktop, television, and watch. Store your media at home, in the cloud, and run the server anywhere.

See takeoutfm.com for further details.

Takeout

The TakeoutFM server, known as Takeout, indexes organized media files in S3 (or local) using MusicBrainz, ListenBrainz, Last.fm, Fanart.tv, and TMDB. Indexed media is browsed using Takeout APIs and securely streamed directly from S3 or local storage. Music, movies, TV shows, podcasts, and radio are supported. Takeout is built as a single binary that includes all server functionality including media syncing, streaming, REST APIs, and a builtin web UI.

See documentation to get started.

Documentation ¶

Index ¶

Constants

Constants ¶

View Source

const (
	AppName = "Takeout"
	Version = "0.26.2"
	Contact = "takeoutfm.com"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

takeout.go

Directories ¶

Path	Synopsis
client Package client provides an (partial) implementation of Takeout API with support for authentication and tokens.	Package client provides an (partial) implementation of Takeout API with support for authentication and tokens.
cmd
playout command
takeout command
internal
activity Package activity manages user activity data.	Package activity manages user activity data.
auth Package auth manages users, passwords, tokens and sessions.	Package auth manages users, passwords, tokens and sessions.
config Package config collects all configuration for the server with a single model which allows for easy viper-based configuration files.	Package config collects all configuration for the server with a single model which allows for easy viper-based configuration files.
film Package film provides support for all movie media.	Package film provides support for all movie media.
music Package music provides support for all music and radio media.	Package music provides support for all music and radio media.
people
playout Package playout is a command line music/podcast/radio player with a text and visual view.	Package playout is a command line music/podcast/radio player with a text and visual view.
podcast Package podcast provides support for all podcast/rss media.	Package podcast provides support for all podcast/rss media.
progress Package progress manages user progress data which contains media offset and duration to allow incremental watch/listen progress to be saved and retrieved to/from the server based on etag.	Package progress manages user progress data which contains media offset and duration to allow incremental watch/listen progress to be saved and retrieved to/from the server based on etag.
server Package server Takeout API	Package server Takeout API
tv
lib
actions This package works with Google Assistant Actions SDK and provides bindings to support json encoding and decoding for some data types.	This package works with Google Assistant Actions SDK and provides bindings to support json encoding and decoding for some data types.
bucket
client Package client provides an http client used extensively by Takeout for syncing media.	Package client provides an http client used extensively by Takeout for syncing media.
date
encoding/xspf
fanart Package fanart provides an interface to obtain artist artwork from Fanart.tv.	Package fanart provides an interface to obtain artist artwork from Fanart.tv.
gorm Package gorm provides an alternative gorm.Model that excludes the time fields from serialization, reducing some API bandwidth usage.	Package gorm provides an alternative gorm.Model that excludes the time fields from serialization, reducing some API bandwidth usage.
hash
header
hub
lastfm
listenbrainz
log
musicbrainz Package musicbrainz provides fairly good support for the MusicBrainz API with focus on the TakeoutFM needs for media syncing and building search metadata.	Package musicbrainz provides fairly good support for the MusicBrainz API with focus on the TakeoutFM needs for media syncing and building search metadata.
pls Package pls provide support for pls files as used in Internet radio streams.	Package pls provide support for pls files as used in Internet radio streams.
rss Package rss provide support for parsing RSS files as used in podcast feeds.	Package rss provide support for parsing RSS files as used in podcast feeds.
search Package search provides a wrapper for bleve search, building a search database for an index of fields.	Package search provides a wrapper for bleve search, building a search database for an index of fields.
setlist
str
systemd
tmdb Package tmdb provides a good coverage for the TMDB API, supporting movies, shows, people and images.	Package tmdb provides a good coverage for the TMDB API, supporting movies, shows, people and images.
token
model
player Package player provides a simple audio player based on Takeout server-based playlists.	Package player provides a simple audio player based on Takeout server-based playlists.
spiff Package spiff provides the model for all playlists used within TakeoutFM.	Package spiff provides the model for all playlists used within TakeoutFM.
tools
cmd/tmdb command
view Package view is the TakeoutFM API viewmodel.	Package view is the TakeoutFM API viewmodel.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL