-
Notifications
You must be signed in to change notification settings - Fork 0
/
.env.template
143 lines (119 loc) · 5.19 KB
/
.env.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
### All environment variables are REQUIRED, unless specified otherwise.
TOMBOIS_SQLITE_LOCATION="/path/to/everything.db"
# External - public facing API
# Port forward or reverse proxy this port to have the public view accessible.
TOMBOIS_SERVER_PORT_EXTERNAL=3000
# Internal - private API for personal management of the database.
# Do NOT port forward or reverse proxy this API, as it is not password
# protected.
TOMBOIS_SERVER_PORT_INTERNAL=3001
# Most endpoints will use the device provided in the API key, however some
# internal endpoints and functions don't, so they will use the device ID present
# in this variable.
TOMBOIS_DEFAULT_DEVICE_ID=""
# The URL at which the external server is accessible from.
# Be sure to take into account a reverse proxy, if you are using one. Rather
# than an IP address and port, it may likely be available at a specific domain.
# Note: Please DO NOT add a trailing slash
TOMBOIS_SERVER_EXTERNAL_URI="http://localhost:3000"
# Similar to the variable above, this is the URL pointing to the internal server
# and, as previously mentioned, should only be accessible behind a firewall, and
# NOT accessible to the internet.
TOMBOIS_SERVER_INTERNAL_URI="http://localhost:3001"
# This is displayed on every page, and used as metadata too.
TOMBOIS_PERSON_NAME="Your Name"
# Add HTML to the bottom of each page.
# Useful for custom analytics code
TOMBOIS_FOOTER_HTML=""
# Cache common pages like the index page, /music, /games, etc. in memory, in
# order to prevent database load.
# Use "0" to disable caching
TOMBOIS_SERVER_CACHE_DURATION_SECS="900"
TOMBOIS_SERVER_CACHE_INTERVAL_SECS="900"
# Google API polling:
# Set POLL_INTERVAL to "0" to disable polling.
# Requires that the provided API key and client have access to the YouTube API.
TOMBOIS_GOOGLE_POLL_INTERVAL="5"
TOMBOIS_GOOGLE_CLIENTID=""
TOMBOIS_GOOGLE_CLIENTSECRET=""
TOMBOIS_GOOGLE_TOKENFILE="data/google-tokens.json"
TOMBOIS_GOOGLE_APIKEY=""
# Steam API polling for game activity
# Set POLL_INTERVAL to "0" to disable polling
# See: https://developer.valvesoftware.com/wiki/Steam_Web_API#GetRecentlyPlayedGames_(v0001)
# Get an API Key from here: https://steamcommunity.com/dev/apikey
TOMBOIS_STEAM_POLL_INTERVAL="10"
TOMBOIS_STEAM_APIKEY=""
TOMBOIS_STEAM_USERID=""
TOMBOIS_STEAM_DATA_FILE="data/steam-activity.json"
TOMBOIS_STEAM_DEVICE_ID=""
# Used to fetch images for PSN and RetroAchievement games,
# which match the same dimensions as Steam
TOMBOIS_STEAMGRIDDB_APIKEY=""
# PSN API polling for game activity
# Set POLL_INTERVAL to "0" to disable polling
TOMBOIS_PSN_NPSSO=""
TOMBOIS_PSN_POLL_INTERVAL="5"
TOMBOIS_PSN_DATA_FILE="data/psn-activity.json"
TOMBOIS_PSN_DEVICE_ID=""
# RetroAchievements API polling for emulator game activity
# Set POLL_INTERVAL to "0" to disable polling
TOMBOIS_RETROACHIEVEMENTS_USERNAME=""
TOMBOIS_RETROACHIEVEMENTS_APIKEY=""
TOMBOIS_RETROACHIEVEMENTS_POLL_INTERVAL="60"
TOMBOIS_RETROACHIEVEMENTS_DEVICE_ID=""
# Monzo Webhooks
# Used to validate webhook is set up properly
# See: https://docs.monzo.com/#webhooks
# See: https://developers.monzo.com/
# Optional (unless you set up a webhook, in which case it's required).
TOMBOIS_MONZO_ACCOUNT_ID=""
# Subsonic API - for manual album scrobbling
# (useful when listening to physical media)
# Leave blank to disable.
TOMBOIS_SUBSONIC_URL=""
TOMBOIS_SUBSONIC_USERNAME=""
TOMBOIS_SUBSONIC_PASSWORD=""
# Sonarr API - for tracking TV shows
# Your API key can be found at `/settings/general` on your Sonarr instance.
# Leave blank to disable.
TOMBOIS_SONARR_URL=""
TOMBOIS_SONARR_APIKEY=""
# Letterboxd - for tracking films
# Just your username, it uses the Letterboxd RSS to fetch new films
# Leave USERNAME blank, or set POLL_INTERVAL_SECS to "0" to disable.
TOMBOIS_LETTERBOXD_USERNAME=""
TOMBOIS_LETTERBOXD_DATA_FILE="data/letterboxd.json"
TOMBOIS_LETTERBOXD_POLL_INTERVAL_SECS="86400"
# TMDB - for fetching films' backdrop images
# Leave this blank to turn off image fetching
# See: https://www.themoviedb.org/settings/api
TOMBOIS_TMDB_ACCESS_TOKEN=""
# Discord Bot
# Both variables are required, otherwise the bot will not be enabled.
# You can get a token from here: https://discord.com/developers/applications
TOMBOIS_DISCORD_TOKEN=""
TOMBOIS_DISCORD_CHANNELID=""
# Geocoder
# Used for determining the city/state you're currently located in.
# Not at all required for location history, unless you wish to display it on the
# homepage dashboard.
TOMBOIS_GEOCODER_ENABLED="true"
TOMBOIS_GEOCODER_CACHE_PATH="data/geocoder.json"
# Bluesky post syndication
# Makes a copy of any public posts you make on Bluesky
# To turn off, leave USERNAME blank, or set POLL_INTERVAL_MINS to "0"
TOMBOIS_BLUESKY_USERNAME="did:plc:..."
TOMBOIS_BLUESKY_DATA_FILE="data/bluesky.json"
TOMBOIS_BLUESKY_POLL_INTERVAL_MINS="120"
TOMBOIS_BLUESKY_INCLUDE_REPLIES="true"
# This is false by default because if someone deletes something you've reposted,
# it won't get removed from your site automatically.
TOMBOIS_BLUESKY_INCLUDE_REPOSTS="false"
# Set the system timezone.
# Optional by default, BUT necessary if you're using Docker.
TZ="Europe/London"
# Used in `test/Requests.http` and nothing else.
# Generate an API key for a device and plug it here, if you wish to test the API
# using the endpoints in that file.
TOMBOIS_TEST_APIKEY=""