forked from elfhosted/elfhosted.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
366 lines (340 loc) · 11 KB
/
mkdocs.yml
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
site_name: "ElfHosted / app hosting that works like magic! 🪄"
site_description: App hosting that works like magic! 🪄
site_author: 'David Young'
site_url: 'https://elfhosted.com'
edit_uri: 'edit/main/docs/'
# Fail to build if we have broken links
# strict: true
# Copyright
copyright: 'Copyright © 2024 David Young, Funky Penguin Limited'
# Repository
repo_name: 'elfhosted.com'
repo_url: 'https://github.com/geek-cookbook/elfhosted.com'
# Plugins
plugins:
search:
minify:
minify_html: true
autolinks:
git-revision-date-localized:
type: date
fallback_to_build_date: true
macros:
verbose: true
include_dir: _includes
meta-descriptions: # If not provided, auto-generate a description (https://pypi.org/project/mkdocs-meta-descriptions-plugin/)
meta:
blog:
# post_excerpt: required
post_url_format: "{date}/{file}" # this allows us to change the post title in future without breaking URLs
tags:
tags_file: blog/tags.md
rss:
match_path: blog/posts/.*
date_from_meta:
as_creation: date
categories:
- categories
- tags
abstract_chars_count: 500
image: https://elfhosted.com/images/logo.png
url_parameters:
utm_source: "elfhosted-com"
utm_medium: "RSS"
utm_campaign: "feed-syndication"
social:
# debug: true
# debug_color: yellow
cards_layout: elfhosted
privacy:
external_links_attr_map:
target: _blank
rel: nofollow
external_assets_exclude:
- img.shields.io/*
- i.imgflip.com/*
optimize:
enabled: false # pngquant issue?
#theme_dir: mkdocs-material
nav:
- Home:
- index.md
- Apps:
- apps/index.md # yes, the plural is intentional
- Consume Media:
- Audiobookshelf: app/audiobookshelf.md
- Calibre: app/calibre.md
- Calibre Web: app/calibre-web.md
- Emby: app/emby.md
- Jellyfin: app/jellyfin.md
- Kavita: app/kavita.md
- Komga: app/komga.md
- Navidrome: app/navidrome.md
- Plex: app/plex.md
- Stremio Server: app/stremio-server.md
- Stremio Web: app/stremio-web.md
- Manage Media:
- Autobrr: app/autobrr.md
- Bazarr: app/bazarr.md
- Jellyfin Accounts: app/jellyfin-accounts.md
- Jellyseerr: app/jellyseerr.md
- Lazy Librarian: app/lazylibrarian.md
- Lidarr: app/lidarr.md
- Mylar: app/mylar.md
- NextPVR: app/nextpvr.md
- Notifiarr: app/notifiarr.md
- Ombi: app/ombi.md
- Overseerr: app/overseerr.md
- Plex Meta Manager: app/plex-meta-manager.md
- Radarr: app/radarr.md
- Readarr: app/readarr.md
- RPDB: app/rpdb.md
- Shoko: app/shoko.md
- Sonarr: app/sonarr.md
- Tautulli: app/tautulli.md
- Tdarr: app/tdarr.md
- xTeVe: app/xteve.md
- Manage Downloads:
- AirDC++: app/airdcpp.md
- Autobrr: app/autobrr.md
- Deluge: app/deluge.md
- Flaresolverr: app/flaresolverr.md
- Iceberg: app/iceberg.md
- Jackett: app/jackett.md
- NZBGet: app/nzbget.md
- NZBHydra: app/nzbhydra.md
- Openbooks: app/openbooks.md
- Plex-Debrid: app/plex-debrid.md
- Prowlarr: app/prowlarr.md
- Pyload: app/pyload.md
- qBittorrent: app/qbittorrent.md
- Rapidleech: app/rapidleech.md
- RDT Client: app/rdtclient.md
- Riven: app/riven.md
- ruTorrent: app/rutorrent.md
- SABnzbd: app/sabnzbd.md
- Unpackerr: app/unpackerr.md
- Youtube DL: app/youtubedl.md
- Zurg: app/zurg.md
- Tools:
- Code Server: app/code-server.md
- ElfBot: app/elfbot.md
- Filebrowser: app/filebrowser.md
- Gluetun: app/gluetun.md
- Gotify: app/gotify.md
- Homepage: app/homepage.md
- Joplin Server: app/joplin-server.md
- Kubernetes Dashboard: app/kubernetes-dashboard.md
- Mattermost: app/mattermost.md
- Miniflux: app/miniflux.md
- Privatebin: app/privatebin.md
- RCloneFM: app/rclonefm.md
- RCloneUI: app/rcloneui.md
- Recyclarr: app/recyclarr.md
- Resilio Sync: app/resiliosync.md
- Seafile: app/seafile.md
- Syncthing: app/syncthing.md
- The Lounge: app/thelounge.md
- Uptime Kuma: app/uptimekuma.md
- Vaultwarden: app/vaultwarden.md
- Wallabag: app/wallabag.md
- WebDAV Access: app/webdav.md
- Stremio Addons:
- stremio-addons/index.md
- Annatar: app/annatar.md
- Comet: app/comet.md
- KnightCrawler: app/torrentio.md
- MediaFusion: app/mediafusion.md
- Shluflix: app/shluflix.md
- Stremify: app/stremify.md
- Stremio-Jackett: app/stremio-jackett.md
- Torrentio: app/torrentio.md
- Xtremio: app/xtremio.md
- Store : https://store.elfhosted.com
- Guides:
- Media:
- guides/media/index.md
- Magical Infinite Streaming with Plex / Riven: guides/media/stream-from-real-debrid-with-plex-riven.md
- Infinite Streaming with Stremio and Jackett: guides/media/stream-from-real-debrid-with-stremio-jackett.md
- Infinite Streaming with Plex: guides/media/stream-from-real-debrid-with-plex.md
- Advanced Infinite Streaming with Plex and Arrs: guides/media/stream-from-real-debrid-with-plex-radarr-sonarr-prowlarr.md
- Advanced Infinite Streaming with with Jellyfin and Arrs: guides/media/stream-from-real-debrid-with-jellyfin-radarr-sonarr-prowlarr.md
- Advanced Infinite Streaming with with Emby and Arrs: guides/media/stream-from-real-debrid-with-emby-radarr-sonarr-prowlarr.md
- Simultaneous Streaming with Stremio Server and Debrid: guides/media/stream-from-real-debrid-with-stremio-from-with-multiple-ip-addresses-simultaneously.md
- Optimizing your movie quality with TRaSH Guides custom formats: guides/media/optimize-movie-quality-with-trash-custom-formats.md
- Optimizing your series quality with TRaSH Guides custom formats: guides/media/optimize-series-quality-with-trash-custom-formats.md
# - Plex Cloud: guides/your-own-plex-cloud.md
- Support:
- get-help.md
- Discord: https://discord.elfhosted.com
- Troubleshoot: how-to/troubleshoot.md
- Migrate Datacenters: how-to/migrate-datacenters.md
- ElfBuckz: how-to/spend-elfbuckz.md
- Plex Token: how-to/get-plex-token.md
- StorageBox: what-is/storagebox.md
- Use rclone: how-to/use-rclone.md
- Connect Apps: how-to/connect-apps.md
- Data Retention: how-to/delete-your-data.md
- Use ElfTerm: how-to/use-elfterm.md
# - Public IPs: how-to/whitelist-our-public-ips.md
# - Bugs: how-to/report-bug.md
# - Suggestions: how-to/add-suggestion.md
- FAQ: faq.md
- Team: team.md
- Blog:
- blog/index.md
- Tags: blog/tags.md
- Legal:
- legal/index.md
- Acceptable Use: legal/acceptable-use.md
- Privacy Policy: legal/privacy-policy.md
- Terms of Service: legal/terms-of-service.md
# - Refund Policy: legal/refund-policy.md
- Open:
- open/index.md
- Design:
- open-source/design/index.md
- Reports:
- Aug 2024: open/aug-2024.md
- Jul 2024: open/jul-2024.md
- Jun 2024: open/jun-2024.md
- May 2024: open/may-2024.md
- Apr 2024: open/apr-2024.md
- Mar 2024: open/mar-2024.md
- Feb 2024: open/feb-2024.md
- Jan 2024: open/jan-2024.md
- Dec 2023: open/dec-2023.md
- Nov 2023: open/nov-2023.md
- Oct 2023: open/oct-2023.md
- Sep 2023: open/september-2023.md
- Aug 2023: open/august-2023.md
- Jul 2023: open/july-2023.md
- Jun 2023: open/june-2023.md
- Traffic:
- elfhosted.com: open/traffic/elfhosted.com.md
- store.elfhosted.com: open/traffic/store.elfhosted.com.md
- Sponsorship: open/sponsorship.md
- Pricing: open/pricing.md
- Contribute:
- contribute/index.md
- Testimonials: testimonials.md
- My Account : https://store.elfhosted.com/my-account
theme:
name: 'material'
custom_dir: 'overrides'
favicon: 'images/logo.png'
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.instant
# - navigation.sections
- navigation.indexes
- navigation.top
- navigation.pruning
- navigation.path
- search.suggest
- search.share
- content.code.annotate
- content.code.copy
- header.autohide
- announce.dismiss
- toc.follow
icon:
logo: material/server-security
repo: 'fontawesome/brands/github'
tag:
kubernetes: material/kubernetes
js: fontawesome/brands/js
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
scheme: default
toggle:
icon: material/brightness-auto
name: Follow system preferences
# Toggle light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: 'custom'
accent: 'green'
toggle:
icon: material/brightness-7
name: Burn my eyes!
# Toggle dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: 'custom'
accent: 'green'
toggle:
icon: material/brightness-4
name: Love my eyes!
font:
text: 'Ubuntu'
code: 'Ubuntu Mono'
extra_css:
- extras/css/icons.css
- extras/css/stylesheets.css
extra:
status:
new: Recently added
deprecated: Deprecated
social:
- icon: 'fontawesome/brands/discord'
link: 'http://discord.elfhosted.com'
- icon: 'fontawesome/brands/reddit'
link: 'https://reddit.com/r/elfhosted'
- icon: 'fontawesome/brands/youtube'
link: 'https://www.youtube.com/@elfhostme'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/elfhosted'
- icon: 'fontawesome/brands/github'
link: 'https://github.com/elfhosted'
extra_javascript:
# - extras/javascript/plausible.js
# - extras/javascript/widgetbot.js # uncommented for dev
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
- extras/javascript/tablesort.js
# Extensions
markdown_extensions:
- attr_list
- admonition
- codehilite:
linenums: true
- toc:
permalink: false
toc_depth: 3 # ignore H4/5/6
- footnotes
- pymdownx.critic
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.snippets:
check_paths: true
base_path: _snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.inlinehilite
- pymdownx.magiclink:
repo_url_shorthand: true
user: geek-cookbook
repo: elfhosted.com
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.tabbed:
alternate_style: true
- meta
- md_in_html