You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- <spanclass="tag-neutral">Type: Number</span>: Will get converted to a number
14
-
- <spanclass="tag-neutral">Type: Boolean</span>: Will evaluate to `True` to _enable_ the discribed functionality. Set to anything except blank string to enable. To disable, remove the variable.
14
+
- <spanclass="tag-neutral">Type: Boolean</span>: Will evaluate to `True` to _enable_ the described functionality. Set to anything except blank string to enable. To disable, remove the variable.
15
+
16
+
!!! tip
17
+
Some environment variables can be suffixed with `_FILE` to allow passing in passwords using docker secretes.
15
18
16
19
## TA_HOST
17
20
<spanclass="tag-alert">Required</span>
18
21
<spanclass="tag-neutral">Type: String</span>
19
22
20
-
Set the environment variable `TA_HOST` to match with the expected origin from where you will access your **Tube Archivist** instance. That is whatever you input into your browser URL bar.
23
+
Set the environment variable `TA_HOST` to match with the expected origin from where you will access your **Tube Archivist** instance. That is whatever you input into your browser URL bar.
21
24
22
25
- This can be a domain like *example.com*, a subdomain like *ta.example.com* or an IP address like *192.168.1.20*.
23
26
- Define the protocol, e.g. `https://` oder `http://`.
@@ -28,19 +31,22 @@ Set the environment variable `TA_HOST` to match with the expected origin from wh
28
31
29
32
## TA_USERNAME
30
33
<spanclass="tag-alert">Required</span>
31
-
<spanclass="tag-neutral">Type: String</span>
34
+
<spanclass="tag-neutral">Type: String</span>
32
35
Username for your initial credentials. Changing that after first time starting the application won't have any effect. Use the admin interface to change or add that.
33
36
34
37
## TA_PASSWORD
35
38
<spanclass="tag-alert">Required</span>
36
-
<spanclass="tag-neutral">Type: String</span>
39
+
<spanclass="tag-neutral">Type: String</span>
37
40
Password for your initial user. Changing that after creating the user, does not have any effect. Use the admin interface to change your password.
38
41
42
+
!!! tip
43
+
`TA_PASSWORD` can be suffixed with `_FILE` to allow passing in passwords using docker secretes.
44
+
39
45
If you forgot your password, see [User Management/#Forgot Password](../users.md#forgot-password).
40
46
41
47
## TZ
42
48
<spanclass="tag-optional">Optional</span>
43
-
<spanclass="tag-neutral">Type: String</span>
49
+
<spanclass="tag-neutral">Type: String</span>
44
50
Your timezone. This is used for the scheduler. Defaults to UTC.
45
51
46
52
!!! warning "Canonical vs Linked Timezones"
@@ -51,90 +57,94 @@ Your timezone. This is used for the scheduler. Defaults to UTC.
51
57
52
58
## HOST_UID and HOST_GID
53
59
<spanclass="tag-optional">Optional</span>
54
-
<spanclass="tag-neutral">Type: Number</span>
55
-
Change the user and group owning the media files generated by TubeArchivist. This uses `chown` on the output files.
60
+
<spanclass="tag-neutral">Type: Number</span>
61
+
Change the user and group owning the media files generated by TubeArchivist. This uses `chown` on the output files.
56
62
57
63
!!! warning "Filesystem Compatibility"
58
-
Not all filesystems support `chown`. Notably `NFS` does not have functionality to change the ownership of files.
64
+
Not all filesystems support `chown`. Notably `NFS` does not have functionality to change the ownership of files.
59
65
60
66
You will see a error like `PermissionError: [Errno 1] Operation not permitted` when TA is trying to change the ownership of the downloaded file.
61
67
62
68
_Not_ setting these variables, will disable the chown functionality.
63
69
64
70
## TA_PORT
65
71
<spanclass="tag-optional">Optional</span>
66
-
<spanclass="tag-neutral">Type: Number</span>
72
+
<spanclass="tag-neutral">Type: Number</span>
67
73
This changes the actual port Nginx is listening on. That is the public port exposed through the docker container. If you have a port collision on default port 8000, see bellow.
68
74
69
75
## TA_BACKEND_PORT
70
76
<spanclass="tag-optional">Optional</span>
71
-
<spanclass="tag-neutral">Type: Number</span>
77
+
<spanclass="tag-neutral">Type: Number</span>
72
78
This changes the port where the backend service is running on. That is container internal only, but you might need to change that if you use a shared docker network and have a port collision there.
73
79
74
80
## TA_ENABLE_AUTH_PROXY
75
81
<spanclass="tag-optional">Optional</span>
76
-
<spanclass="tag-neutral">Type: Boolean</span>
82
+
<spanclass="tag-neutral">Type: Boolean</span>
77
83
Configure TA to authenticate with a auth proxy. See [configuration/forward-auth](../configuration/forward-auth.md) for more details.
78
84
79
85
## TA_LDAP
80
86
<spanclass="tag-optional">Optional</span>
81
-
<spanclass="tag-neutral">Type: Boolean</span>
87
+
<spanclass="tag-neutral">Type: Boolean</span>
82
88
Configure TA to use LDAP for authentication. See [configuration/ldap](../configuration/ldap.md) for more details.
83
89
84
90
## TA_AUTO_UPDATE_YTDLP
85
91
<spanclass="tag-optional">Optional</span>
86
-
<spanclass="tag-neutral">Type: String</span>
92
+
<spanclass="tag-neutral">Type: String</span>
87
93
!!! warning "Potential Incompatibility"
88
94
Future versions of yt-dlp may not be compatible with your current Tube Archivist version. Subtle changes in yt-dlp might lead to unexpected, incomplete or wrong data getting indexed. If you use this, make sure to have your backup up to date and monitor that the metadata indexed is as expected.
89
95
90
-
If you are experiencing any problems, please report them, so we can address them ahead of a regular relese.
96
+
If you are experiencing any problems, please report them, so we can address them ahead of a regular release.
91
97
92
98
Configure TA to automatically install the latest yt-dlp on container start. Enable by setting to `release` or `nightly` depending on which version you would like to install.
93
99
94
100
## DISABLE_STATIC_AUTH
95
101
<spanclass="tag-optional">Optional</span>
96
-
<spanclass="tag-neutral">Type: Boolean</span>
102
+
<spanclass="tag-neutral">Type: Boolean</span>
97
103
This will disable authentication for static assets like your video mp4 files, subtitles and artwork. This might be required if you need to access the media files over the HTTP server but you are not able to pass authentication headers.
98
104
99
105
!!! info
100
106
This is `read only` access and does not allow for deleting/modifying any media files. But it is still recommended limit exposure or add additional protections if you enable that.
101
107
102
108
## DJANGO_DEBUG
103
109
<spanclass="tag-optional">Optional</span>
104
-
<spanclass="tag-neutral">Type: Boolean</span>
110
+
<spanclass="tag-neutral">Type: Boolean</span>
105
111
Enable debug to show additional log information like HTTP requests and yt-dlp configurations in your Docker logs. Helpful for development and debugging.
106
112
107
113
!!! warning "Memory Leak"
108
114
Only set this temporarily if you need to inspect some specific problem. Don't forget to remove it again after. This introduces a memory leak plus standard error messages from the backend will be in HTML showing a detailed stack trace and additional info instead of JSON, meaning the frontend is not able to display any error messages.
109
115
110
116
## REDIS_CON
111
117
<spanclass="tag-alert">Required</span>
112
-
<spanclass="tag-neutral">Type: String</span>
118
+
<spanclass="tag-neutral">Type: String</span>
113
119
Connection string for your Redis instance. Specify protocol, host and port.
114
120
E.g.: `redis://archivist-redis:6379`
115
121
116
122
## ES_URL
117
123
<spanclass="tag-alert">Required</span>
118
-
<spanclass="tag-neutral">Type: String</span>
119
-
URL for your ElasticSearch instance. Add protocol and port.
124
+
<spanclass="tag-neutral">Type: String</span>
125
+
URL for your ElasticSearch instance. Add protocol and port.
120
126
E.g. `http://archivist-es:9200`.
121
127
122
128
## ELASTIC_PASSWORD
123
129
<spanclass="tag-alert">Required</span>
124
-
<spanclass="tag-neutral">Type: String</span>
130
+
<spanclass="tag-neutral">Type: String</span>
125
131
This is the password for ElasticSearch. Make sure it matches with the equivalent password set for the ElasticSearch container.
126
132
133
+
!!! tip
134
+
`ELASTIC_PASSWORD` can be suffixed with `_FILE` to allow passing in passwords using docker secretes.
135
+
The `_FILE` convention is also supported by the [ElasticSearch](https://www.elastic.co/docs/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure) docker image.
136
+
127
137
## ELASTIC_USER
128
138
<spanclass="tag-optional">Optional</span>
129
-
<spanclass="tag-neutral">Type: String</span>
139
+
<spanclass="tag-neutral">Type: String</span>
130
140
Optionally change the ElasticSearch username from the default `elastic`.
131
141
132
142
## ES_DISABLE_VERIFY_SSL
133
143
<spanclass="tag-optional">Optional</span>
134
-
<spanclass="tag-neutral">Type: Boolean</span>
144
+
<spanclass="tag-neutral">Type: Boolean</span>
135
145
Optionally disable SSL verification for ElasticSearch. Useful if you use a self signed certificate for ElasticSearch.
136
146
137
147
## ES_SNAPSHOT_DIR
138
148
<spanclass="tag-optional">Optional</span>
139
-
<spanclass="tag-neutral">Type: String</span>
149
+
<spanclass="tag-neutral">Type: String</span>
140
150
Optionally set a custom path where elastic search stores snapshots for master/data nodes. Note, that path applies to inside the ES container.
0 commit comments