From c976c670dd54abddfd4bc76c98637f9bf5a3a18a Mon Sep 17 00:00:00 2001 From: David Young Date: Fri, 15 Oct 2021 18:26:58 +1300 Subject: [PATCH] Update social card descriptions --- manuscript/recipes/autopirate.md | 120 ------------------ manuscript/recipes/autopirate/headphones.md | 2 +- manuscript/recipes/autopirate/index.md | 4 +- manuscript/recipes/autopirate/jackett.md | 2 +- .../recipes/autopirate/lazylibrarian.md | 2 +- manuscript/recipes/autopirate/lidarr.md | 2 +- manuscript/recipes/autopirate/mylar.md | 2 +- manuscript/recipes/autopirate/nzbget.md | 2 +- manuscript/recipes/autopirate/nzbhydra.md | 2 +- manuscript/recipes/autopirate/ombi.md | 2 +- manuscript/recipes/autopirate/radarr.md | 2 +- manuscript/recipes/autopirate/readarr.md | 2 +- manuscript/recipes/autopirate/rtorrent.md | 2 +- manuscript/recipes/autopirate/sabnzbd.md | 2 +- manuscript/recipes/autopirate/sonarr.md | 2 +- manuscript/recipes/bitwarden.md | 4 + manuscript/recipes/bookstack.md | 4 + manuscript/recipes/calibre-web.md | 4 +- manuscript/recipes/collabora-online.md | 4 + manuscript/recipes/cyberchef.md | 4 + manuscript/recipes/duplicati.md | 4 +- manuscript/recipes/elkarbackup.md | 4 +- manuscript/recipes/emby.md | 4 + manuscript/recipes/funkwhale.md | 4 + manuscript/recipes/ghost.md | 4 +- manuscript/recipes/gitlab-runner.md | 4 + manuscript/recipes/gollum.md | 4 +- manuscript/recipes/homeassistant.md | 4 + manuscript/recipes/huginn.md | 4 +- manuscript/recipes/instapy.md | 4 + manuscript/recipes/jellyfin.md | 3 +- manuscript/recipes/kanboard.md | 4 +- manuscript/recipes/keycloak.md | 4 + manuscript/recipes/komga.md | 4 + manuscript/recipes/linx.md | 4 + manuscript/recipes/mail.md | 4 +- manuscript/recipes/mealie.md | 4 + manuscript/recipes/miniflux.md | 4 +- manuscript/recipes/minio.md | 4 + manuscript/recipes/munin.md | 5 + manuscript/recipes/nextcloud.md | 4 +- manuscript/recipes/nightscout.md | 4 + manuscript/recipes/openldap.md | 4 + manuscript/recipes/owntracks.md | 4 + manuscript/recipes/paperless-ng.md | 2 +- manuscript/recipes/photoprism.md | 4 +- manuscript/recipes/phpipam.md | 4 + manuscript/recipes/plex.md | 4 +- manuscript/recipes/portainer.md | 4 +- manuscript/recipes/privatebin.md | 4 + manuscript/recipes/realms.md | 4 + manuscript/recipes/restic.md | 4 + manuscript/recipes/rss-bridge.md | 5 +- manuscript/recipes/swarmprom.md | 4 + manuscript/recipes/template.md | 2 +- manuscript/recipes/tiny-tiny-rss.md | 4 + manuscript/recipes/wallabag.md | 4 +- manuscript/recipes/wekan.md | 4 + manuscript/recipes/wetty.md | 4 +- mkdocs.yml | 1 - 60 files changed, 170 insertions(+), 154 deletions(-) delete mode 100644 manuscript/recipes/autopirate.md diff --git a/manuscript/recipes/autopirate.md b/manuscript/recipes/autopirate.md deleted file mode 100644 index c1b958e..0000000 --- a/manuscript/recipes/autopirate.md +++ /dev/null @@ -1,120 +0,0 @@ -hero: AutoPirate - A fully-featured recipe to automate finding, downloading, and organising your media πŸ“Ί πŸŽ₯ 🎡 πŸ“– - -# AutoPirate - -Once the cutting edge of the "internet" (_pre-world-wide-web and mosiac days_), Usenet is now a murky, geeky alternative to torrents for file-sharing. However, it's **cool** geeky, especially if you're into having a fully automated media platform. - -A good starter for the usenet scene is https://www.reddit.com/r/usenet/. Because it's so damn complicated, a host of automated tools exist to automate the process of finding, downloading, and managing content. The tools included in this recipe are as follows: - -![Autopirate Screenshot](../images/autopirate.png) - -This recipe presents a method to combine these tools into a single swarm deployment, and make them available securely. - -## Menu - -Tools included in the AutoPirate stack are: - -* [SABnzbd][sabnzbd] is the workhorse. It takes `.nzb` files as input (_manually or from [Sonarr](/recipes/autopirate/sonarr/), [Radarr](/recipes/autopirate/radarr/), etc_), then connects to your chosen Usenet provider, downloads all the individual binaries referenced by the .nzb, and then tests/repairs/combines/uncompresses them all into the final result - media files, to be consumed by [Plex](/recipes/plex), [Emby](/recipes/emby/), [Komga](/recipes/komga/), [Calibre-Web](/recipes/calibre-web/), etc. - -* [NZBGet][nzbget] downloads data from usenet servers based on .nzb definitions. Like [SABnzbd][sabnzbd], but written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources (_this is a popular alternative to SABnzbd_) - -* [RTorrent][rtorrent] is a popular CLI-based bittorrent client, and [ruTorrent](https://github.com/Novik/ruTorrent) is a powerful web interface for rtorrent. (_Yes, it's not Usenet, but Sonarr/Radarr will let fulfill your watchlist using either Usenet **or** torrents, so it's worth including_) - -* [NZBHydra][nzbhydra] is a meta search for NZB indexers. It provides easy access to a number of raw and newznab based indexers. You can search all your indexers from one place and use it as indexer source for tools like [Sonarr][sonarr] or [Radarr][radarr]. - -* [Sonarr][sonarr] finds, downloads and manages TV shows - -* [Radarr][radarr] finds, downloads and manages movies - -* [Lidarr][lidarr] is an automated music downloader for NZB and Torrent. It performs the same function as [Headphones][headphones], but is written using the same(ish) codebase as [Radarr][radarr] and [Sonarr](/recipes/autopirate/sonarr). It's blazingly fast, and includes beautiful album/artist art. Lidarr supports [SABnzbd](/recipes/autopirate/sabnzbd/), [NZBGet](/recipes/autopirate/nzbget/), Transmission, Β΅Torrent, Deluge and Blackhole (_just like Sonarr / Radarr_) - -* [Mylar][mylar] is a tool for downloading and managing digital comic books / "graphic novels" - -* [Headphones][headphones] is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, Β΅Torrent, Deluge and Blackhole. - -* [Lazy Librarian][lazylibrarian] is a tool to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. - -* [Ombi][ombi] provides an interface to request additions to a [Plex][plex]/[Emby][emby]/[Jellyfin][jellyfin] library using the above tools - -* [Jackett][jackett] works as a proxy server: it translates queries from apps (*[Sonarr][sonarr], [Radarr][radarr], [Mylar][mylar], etc*) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. - -Since this recipe is so long, and so many of the tools are optional to the final result (_i.e., if you're not interested in comics, you won't want Mylar_), I've described each individual tool on its own sub-recipe page (_below_), even though most of them are deployed very similarly. - - -## Ingredients - -1. [Docker swarm cluster](/ha-docker-swarm/design/) with [persistent shared storage](/ha-docker-swarm/shared-storage-ceph.md) -2. [Traefik](/ha-docker-swarm/traefik) configured per design -3. Access to NZB indexers and Usenet servers -4. DNS entries configured for each of the NZB tools in this recipe that you want to use - -## Preparation - -### Setup data locations - -We'll need a unique directories for each tool in the stack, bind-mounted into our containers, so create them upfront, in /var/data/autopirate: - -``` -mkdir /var/data/autopirate -cd /var/data/autopirate -mkdir -p {lazylibrarian,mylar,ombi,sonarr,radarr,headphones,plexpy,nzbhydra,sabnzbd,nzbget,rtorrent,jackett} -``` - -Create a directory for the storage of your downloaded media, i.e., something like: - -``` -mkdir /var/data/media -``` - -Create a user to "own" the above directories, and note the uid and gid of the created user. You'll need to specify the UID/GID in the environment variables passed to the container (in the example below, I used 4242 - twice the meaning of life). - -### Secure public access - -What you'll quickly notice about this recipe is that __every__ web interface is protected by an [OAuth proxy](/reference/oauth_proxy/). - -Why? Because these tools are developed by a handful of volunteer developers who are focused on adding features, not necessarily implementing robust security. Most users wouldn't expose these tools directly to the internet, so the tools have rudimentary (if any) access control. - -To mitigate the risk associated with public exposure of these tools (_you're on your smartphone and you want to add a movie to your watchlist, what do you do, hotshot?_), in order to gain access to each tool you'll first need to authenticate against your given OAuth provider. - -This is tedious, but you only have to do it once. Each tool (Sonarr, Radarr, etc) to be protected by an OAuth proxy, requires unique configuration. I use github to provide my oauth, giving each tool a unique logo while I'm at it (make up your own random string for OAUTH2PROXYCOOKIE_SECRET) - -For each tool, create /var/data/autopirate/.env, and set the following: - -``` -OAUTH2_PROXY_CLIENT_ID= -OAUTH2_PROXY_CLIENT_SECRET= -OAUTH2_PROXY_COOKIE_SECRET= -PUID=4242 -PGID=4242 -``` - -Create at least /var/data/autopirate/authenticated-emails.txt, containing at least your own email address with your OAuth provider. If you wanted to grant access to a specific tool to other users, you'd need a unique authenticated-emails-.txt which included both normal email address as well as any addresses to be granted tool-specific access. - -### Setup components - -#### Stack basics - -**Start** with a swarm config file in docker-compose syntax, like this: - -```` -version: '3' - -services: -```` - -And **end** with a stanza like this: - -```` -networks: - traefik_public: - external: true - internal: - driver: overlay - ipam: - config: - - subnet: 172.16.11.0/24 -```` - ---8<-- "reference-networks.md" ---8<-- "recipe-autopirate-toc.md" ---8<-- "recipe-footer.md" \ No newline at end of file diff --git a/manuscript/recipes/autopirate/headphones.md b/manuscript/recipes/autopirate/headphones.md index c547cdb..2fc0508 100644 --- a/manuscript/recipes/autopirate/headphones.md +++ b/manuscript/recipes/autopirate/headphones.md @@ -1,5 +1,5 @@ --- -description: Headphones 🎧 is an automated music downloader for NZB and BitTorrent +description: Headphones is an automated music downloader for NZB and BitTorrent --- # Headphones !!! warning diff --git a/manuscript/recipes/autopirate/index.md b/manuscript/recipes/autopirate/index.md index de38bcc..b6afeb3 100644 --- a/manuscript/recipes/autopirate/index.md +++ b/manuscript/recipes/autopirate/index.md @@ -1,4 +1,6 @@ -hero: AutoPirate - A fully-featured recipe to automate finding, downloading, and organising your media πŸ“Ί πŸŽ₯ 🎡 πŸ“– +--- +description: A fully-featured recipe to automate finding, downloading, and organising media +--- # AutoPirate diff --git a/manuscript/recipes/autopirate/jackett.md b/manuscript/recipes/autopirate/jackett.md index 4f86b16..c845136 100644 --- a/manuscript/recipes/autopirate/jackett.md +++ b/manuscript/recipes/autopirate/jackett.md @@ -1,5 +1,5 @@ --- -description: Jackett πŸ§₯ works as a proxy server, standardizing your apps' access to torrent indexers +description: Jackett works as a proxy server, standardizing your apps' access to torrent indexers --- # Jackett diff --git a/manuscript/recipes/autopirate/lazylibrarian.md b/manuscript/recipes/autopirate/lazylibrarian.md index f70bf13..3d4a563 100644 --- a/manuscript/recipes/autopirate/lazylibrarian.md +++ b/manuscript/recipes/autopirate/lazylibrarian.md @@ -1,5 +1,5 @@ --- -description: LazyLibrarian πŸ“š is a tool to follow authors and grab metadata for all your digital reading needs. +description: LazyLibrarian is a tool to follow authors and grab metadata for all your digital reading needs. --- # LazyLibrarian diff --git a/manuscript/recipes/autopirate/lidarr.md b/manuscript/recipes/autopirate/lidarr.md index 714cb51..afd7afd 100644 --- a/manuscript/recipes/autopirate/lidarr.md +++ b/manuscript/recipes/autopirate/lidarr.md @@ -1,5 +1,5 @@ --- -description: Lidarr 🎡 is an automated music downloader for NZB and Torrent +description: Lidarr is an automated music downloader for NZB and Torrent --- # Lidarr !!! warning diff --git a/manuscript/recipes/autopirate/mylar.md b/manuscript/recipes/autopirate/mylar.md index fe24c35..69a0eb9 100644 --- a/manuscript/recipes/autopirate/mylar.md +++ b/manuscript/recipes/autopirate/mylar.md @@ -1,5 +1,5 @@ --- -description: Mylar πŸ¦Ήβ€β™€οΈ is a tool for downloading and managing digital comic books. +description: Mylar is a tool for downloading and managing digital comic books. --- # Mylar diff --git a/manuscript/recipes/autopirate/nzbget.md b/manuscript/recipes/autopirate/nzbget.md index 4e49056..aca6086 100644 --- a/manuscript/recipes/autopirate/nzbget.md +++ b/manuscript/recipes/autopirate/nzbget.md @@ -1,5 +1,5 @@ --- -description: NZBGet πŸ’Ύ is a tool for downloading "content" from Usenet providers +description: NZBGet is a tool for downloading "content" from Usenet providers --- # NZBGet diff --git a/manuscript/recipes/autopirate/nzbhydra.md b/manuscript/recipes/autopirate/nzbhydra.md index f40ad0b..37f50d5 100644 --- a/manuscript/recipes/autopirate/nzbhydra.md +++ b/manuscript/recipes/autopirate/nzbhydra.md @@ -1,5 +1,5 @@ --- -description: NZBHydra 🐍 is a meta search engine for NZB indexers +description: NZBHydra is a meta search engine for NZB indexers --- # NZBHydra 2 diff --git a/manuscript/recipes/autopirate/ombi.md b/manuscript/recipes/autopirate/ombi.md index 2f0a1ef..bdc8b48 100644 --- a/manuscript/recipes/autopirate/ombi.md +++ b/manuscript/recipes/autopirate/ombi.md @@ -1,5 +1,5 @@ --- -description: Ombi is like your media butler 🍽 - it recommends, finds what you want to watch! +description: Ombi is like your media butler - it recommends, finds what you want to watch! --- # Ombi diff --git a/manuscript/recipes/autopirate/radarr.md b/manuscript/recipes/autopirate/radarr.md index ccd1877..f0453b6 100644 --- a/manuscript/recipes/autopirate/radarr.md +++ b/manuscript/recipes/autopirate/radarr.md @@ -1,5 +1,5 @@ --- -description: Radarr 🎬 is a tool for finding, downloading and managing movies +description: Radarr is a tool for finding, downloading and managing movies --- # Radarr diff --git a/manuscript/recipes/autopirate/readarr.md b/manuscript/recipes/autopirate/readarr.md index 6d04918..53a209d 100644 --- a/manuscript/recipes/autopirate/readarr.md +++ b/manuscript/recipes/autopirate/readarr.md @@ -1,5 +1,5 @@ --- -description: Readarr πŸ“š is "Sonarr/Radarr for eBooks" +description: Readarr is "Sonarr/Radarr for eBooks" --- diff --git a/manuscript/recipes/autopirate/rtorrent.md b/manuscript/recipes/autopirate/rtorrent.md index e8f6fb3..277d440 100644 --- a/manuscript/recipes/autopirate/rtorrent.md +++ b/manuscript/recipes/autopirate/rtorrent.md @@ -1,5 +1,5 @@ --- -description: A popular tool for managing BitTorrent πŸ’Ύ downloads +description: A popular tool for managing BitTorrent downloads --- # RTorrent / ruTorrent diff --git a/manuscript/recipes/autopirate/sabnzbd.md b/manuscript/recipes/autopirate/sabnzbd.md index ff0ad25..afbf507 100644 --- a/manuscript/recipes/autopirate/sabnzbd.md +++ b/manuscript/recipes/autopirate/sabnzbd.md @@ -1,5 +1,5 @@ --- -description: SABnzbd πŸ’Ύ downloads and assembles your usenet content +description: SABnzbd downloads and assembles your usenet content --- # SABnzbd diff --git a/manuscript/recipes/autopirate/sonarr.md b/manuscript/recipes/autopirate/sonarr.md index 0e6c157..e4dce2d 100644 --- a/manuscript/recipes/autopirate/sonarr.md +++ b/manuscript/recipes/autopirate/sonarr.md @@ -1,5 +1,5 @@ --- -description: Sonarr πŸ“Ί is a tool for finding, downloading and managing TV series +description: Sonarr is a tool for finding, downloading and managing TV series --- # Sonarr diff --git a/manuscript/recipes/bitwarden.md b/manuscript/recipes/bitwarden.md index 2d14b22..32b5dbb 100644 --- a/manuscript/recipes/bitwarden.md +++ b/manuscript/recipes/bitwarden.md @@ -1,3 +1,7 @@ +--- +description: Protecting your secritz from all teh haxzors! +--- + # Bitwarden Heard about the [latest password breach](https://www.databreaches.net) (*since lunch*)? [HaveYouBeenPowned](http://haveibeenpwned.com) yet (*today*)? [Passwords are broken](https://www.theguardian.com/technology/2008/nov/13/internet-passwords), and as the amount of sites for which you need to store credentials grows exponetially, so does the risk of using a common password. diff --git a/manuscript/recipes/bookstack.md b/manuscript/recipes/bookstack.md index 1c74cc6..c0a790a 100644 --- a/manuscript/recipes/bookstack.md +++ b/manuscript/recipes/bookstack.md @@ -1,3 +1,7 @@ +--- +description: BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information +--- + # BookStack BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information. diff --git a/manuscript/recipes/calibre-web.md b/manuscript/recipes/calibre-web.md index e91858d..3729d2c 100644 --- a/manuscript/recipes/calibre-web.md +++ b/manuscript/recipes/calibre-web.md @@ -1,4 +1,6 @@ -hero: Manage your ebook collection. Like a BOSS. +--- +description: Manage your ebook collection. Like a BOSS. +--- # Calibre-Web diff --git a/manuscript/recipes/collabora-online.md b/manuscript/recipes/collabora-online.md index 21e55c0..ca9ee93 100644 --- a/manuscript/recipes/collabora-online.md +++ b/manuscript/recipes/collabora-online.md @@ -1,3 +1,7 @@ +--- +description: Collabora Online is a FOSS alternative to MS Office, in your browser! +--- + # Collabora Online Collabora Online Development Edition (or "[CODE](https://www.collaboraoffice.com/code/#what_is_code)"), is the lightweight, or "home" edition of the commercially-supported [Collabora Online](https://www.collaboraoffice.com/collabora-online/) platform. It diff --git a/manuscript/recipes/cyberchef.md b/manuscript/recipes/cyberchef.md index f6466a2..6864b5f 100644 --- a/manuscript/recipes/cyberchef.md +++ b/manuscript/recipes/cyberchef.md @@ -1,3 +1,7 @@ +--- +description: Be a l33t h@xor with this toolkit from the GHCQ +--- + # CyberChef Are you a [l33t h@x0r](https://en.wikipedia.org/wiki/Hackers_(film))? Do you need the right tools at your fingertips to support your [#masterhacker](https://reddit.com/r/masterhacker) skillz? Look no further than CyberChef, lovingly baked for you by your friends at GHCQ[^1]! diff --git a/manuscript/recipes/duplicati.md b/manuscript/recipes/duplicati.md index c9effa2..52c210d 100644 --- a/manuscript/recipes/duplicati.md +++ b/manuscript/recipes/duplicati.md @@ -1,4 +1,6 @@ -hero: Duplicati - Yet another option to backup your exciting stuff. It's good to have options. +--- +description: Duplicati - Yet another option to backup your exciting stuff. It's good to have options. +--- # Duplicati diff --git a/manuscript/recipes/elkarbackup.md b/manuscript/recipes/elkarbackup.md index d17a2ac..0cf42f8 100644 --- a/manuscript/recipes/elkarbackup.md +++ b/manuscript/recipes/elkarbackup.md @@ -1,4 +1,6 @@ -hero: Real heroes backup their πŸ’Ύ +--- +description: Real heroes backup their shizz! +--- # Elkar Backup diff --git a/manuscript/recipes/emby.md b/manuscript/recipes/emby.md index 1f440f1..593dd96 100644 --- a/manuscript/recipes/emby.md +++ b/manuscript/recipes/emby.md @@ -1,3 +1,7 @@ +--- +description: Kick-ass media player! +--- + # Emby [Emby](https://emby.media/) (_think "M.B." or "Media Browser"_) is best described as "_like [Plex](/recipes/plex/) but different_" 😁 - It's a bit geekier and less polished than Plex, but it allows for more flexibility and customization. diff --git a/manuscript/recipes/funkwhale.md b/manuscript/recipes/funkwhale.md index 9a97a90..dee7bda 100644 --- a/manuscript/recipes/funkwhale.md +++ b/manuscript/recipes/funkwhale.md @@ -1,3 +1,7 @@ +--- +description: Funkwhale is a decentralized, federated music streaming platform +--- + # Funkwhale [Funkwhale](https://funkwhale.audio) is a decentralized, federated, and open music streaming / sharing platform. Think of it as "Mastodon for music". Here's a nifty online [demo](https://demo.funkwhale.audio/) :musical_note: diff --git a/manuscript/recipes/ghost.md b/manuscript/recipes/ghost.md index eaa9b09..f76eccf 100644 --- a/manuscript/recipes/ghost.md +++ b/manuscript/recipes/ghost.md @@ -1,4 +1,6 @@ -hero: Ghost - A recipe for beautiful online publication. +--- +description: Ghost - Beautiful online publicatio (who you gonna call?) +--- # Ghost diff --git a/manuscript/recipes/gitlab-runner.md b/manuscript/recipes/gitlab-runner.md index 28dfefe..4bfd574 100644 --- a/manuscript/recipes/gitlab-runner.md +++ b/manuscript/recipes/gitlab-runner.md @@ -1,3 +1,7 @@ +--- +description: Gitlab Runner - A gopher for GitLab +--- + # Gitlab Runner Some features of GitLab require a "[runner](https://docs.gitlab.com/runner/)" (_in the sense of a "gopher" or a "minion"_). A runner "registers" itself with a GitLab instance, and is given tasks to run. Tasks include running Continuous Integration (CI) builds, and building container images. diff --git a/manuscript/recipes/gollum.md b/manuscript/recipes/gollum.md index 8c67365..1013bf9 100644 --- a/manuscript/recipes/gollum.md +++ b/manuscript/recipes/gollum.md @@ -1,4 +1,6 @@ -hero: Gollum - A recipe for your own git-based wiki +--- +description: Gollum - A recipe for your own git-based wiki. My preciousssss +--- # Gollum diff --git a/manuscript/recipes/homeassistant.md b/manuscript/recipes/homeassistant.md index 6d07c8b..63a8c6d 100644 --- a/manuscript/recipes/homeassistant.md +++ b/manuscript/recipes/homeassistant.md @@ -1,3 +1,7 @@ +--- +description: Assist your home automation +--- + # Home Assistant Home Assistant is a home automation platform written in Python, with extensive support for 3rd-party home-automation platforms including Xaomi, Phillips Hue, and a [bazillion](https://home-assistant.io/components/) others. diff --git a/manuscript/recipes/huginn.md b/manuscript/recipes/huginn.md index 532d9bd..2abc3a1 100644 --- a/manuscript/recipes/huginn.md +++ b/manuscript/recipes/huginn.md @@ -1,4 +1,6 @@ -hero: Huginn - A recipe for self-hosted, hackable version of IFFTT / Zapier +--- +description: A self-hosted, hackable version of IFFTT / Zapier +--- # Huginn diff --git a/manuscript/recipes/instapy.md b/manuscript/recipes/instapy.md index 8855e58..354911e 100644 --- a/manuscript/recipes/instapy.md +++ b/manuscript/recipes/instapy.md @@ -1,3 +1,7 @@ +--- +description: Automate your fake Instagram life with automated fakery! +--- + # InstaPy [InstaPy](https://github.com/timgrossmann/InstaPy) is an Instagram bot, developed by [Tim Grossman](https://github.com/timgrossmann). Tim describes his motivation and experiences developing the bot [here](https://medium.freecodecamp.org/my-open-source-instagram-bot-got-me-2-500-real-followers-for-5-in-server-costs-e40491358340). diff --git a/manuscript/recipes/jellyfin.md b/manuscript/recipes/jellyfin.md index a31cfa1..fbe1df4 100644 --- a/manuscript/recipes/jellyfin.md +++ b/manuscript/recipes/jellyfin.md @@ -1,6 +1,7 @@ --- -description: Jellyfin is best described as "like Emby but really FOSS". It started as an Emby fork, but has evolved significantly since then, with its own advantages over Emby. +description: Jellyfin is best described as "like Emby but really FOSS" --- + # Jellyfin [Jellyfin](https://jellyfin.org/) is best described as "_like [Emby](/recipes/emby) but really [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software)_". diff --git a/manuscript/recipes/kanboard.md b/manuscript/recipes/kanboard.md index 69b83b7..b40f7e5 100644 --- a/manuscript/recipes/kanboard.md +++ b/manuscript/recipes/kanboard.md @@ -1,4 +1,6 @@ -hero: Kanboard - A recipe to get your personal kanban on +--- +description: Get your personal kanban on! +--- # Kanboard diff --git a/manuscript/recipes/keycloak.md b/manuscript/recipes/keycloak.md index 11dcefd..b002633 100644 --- a/manuscript/recipes/keycloak.md +++ b/manuscript/recipes/keycloak.md @@ -1,3 +1,7 @@ +--- +description: Kick-ass OIDC and identity management +--- + # KeyCloak [KeyCloak](https://www.keycloak.org/) is "_an open source identity and access management solution_". Using a local database, or a variety of backends (_think [OpenLDAP](/recipes/openldap/)_), you can provide Single Sign-On (SSO) using OpenID, OAuth 2.0, and SAML. KeyCloak's OpenID provider can be used in combination with [Traefik Forward Auth](/ha-docker-swarm/traefik-forward-auth/), to protect [vulnerable services](/recipes/autopirate/nzbget/) with an extra layer of authentication. diff --git a/manuscript/recipes/komga.md b/manuscript/recipes/komga.md index e5055e6..9f8e527 100644 --- a/manuscript/recipes/komga.md +++ b/manuscript/recipes/komga.md @@ -1,3 +1,7 @@ +--- +description: Bazinga! Comic book management FTW! +--- + # Komga So you've just watched a bunch of superhero movies, and you're suddenly inspired to deep-dive into the weird world of comic books? You're already rocking [AutoPirate](/recipes/autopirate/) with [Mylar](/recipes/autopirate/mylar/) and [NZBGet](/recipes/autopirate/nzbget/) to grab content, but how to manage and enjoy your growing collection? diff --git a/manuscript/recipes/linx.md b/manuscript/recipes/linx.md index fe4e121..d3342d7 100644 --- a/manuscript/recipes/linx.md +++ b/manuscript/recipes/linx.md @@ -1,3 +1,7 @@ +--- +description: Quickly share self-destructing screenshots, text, etc +--- + # Linx Ever wanted to quickly share a screenshot, but don't want to use imgur, sign up for a service, or have your image tracked across the internet for all time? diff --git a/manuscript/recipes/mail.md b/manuscript/recipes/mail.md index 71ae838..63d912f 100644 --- a/manuscript/recipes/mail.md +++ b/manuscript/recipes/mail.md @@ -1,4 +1,6 @@ -hero: Docker-mailserver - A recipe for a self-contained mailserver and friends βœ‰οΈ +--- +description: A self-contained mailserver with spam-fighting friends +--- # Mail Server diff --git a/manuscript/recipes/mealie.md b/manuscript/recipes/mealie.md index 585111a..11ff342 100644 --- a/manuscript/recipes/mealie.md +++ b/manuscript/recipes/mealie.md @@ -1,3 +1,7 @@ +--- +description: A tasty tool to manage your meals and shopping list +--- + # Mealie [Mealie](https://github.com/hay-kot/mealie) is a self hosted recipe manager and meal planner (*with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience*) for the whole family. diff --git a/manuscript/recipes/miniflux.md b/manuscript/recipes/miniflux.md index 36b9f1a..17ca00d 100644 --- a/manuscript/recipes/miniflux.md +++ b/manuscript/recipes/miniflux.md @@ -1,4 +1,6 @@ -hero: Miniflux - A recipe for a lightweight minimalist RSS reader +--- +description: A lightweight minimalist RSS reader +--- # Miniflux diff --git a/manuscript/recipes/minio.md b/manuscript/recipes/minio.md index f1f60c2..eed29c9 100644 --- a/manuscript/recipes/minio.md +++ b/manuscript/recipes/minio.md @@ -1,3 +1,7 @@ +--- +description: Self-hosted S3-compatible object storage +--- + # Minio Minio is a high performance distributed object storage server, designed for diff --git a/manuscript/recipes/munin.md b/manuscript/recipes/munin.md index 39dbaa7..c1ad829 100644 --- a/manuscript/recipes/munin.md +++ b/manuscript/recipes/munin.md @@ -1,3 +1,8 @@ + +--- +description: Network resource monitoring tool for quick analysis +--- + # Munin Munin is a networked resource monitoring tool that can help analyze resource trends and "what just happened to kill our performance?" problems. It is designed to be very plug and play. A default installation provides a lot of graphs with almost no work. diff --git a/manuscript/recipes/nextcloud.md b/manuscript/recipes/nextcloud.md index 8e24466..726ccf0 100644 --- a/manuscript/recipes/nextcloud.md +++ b/manuscript/recipes/nextcloud.md @@ -1,4 +1,6 @@ -hero: Backup all your stuff. Share it. Privately. +--- +description: Share docs. Backup files. Share stuff. +--- # NextCloud diff --git a/manuscript/recipes/nightscout.md b/manuscript/recipes/nightscout.md index 867dc2f..a5c2179 100644 --- a/manuscript/recipes/nightscout.md +++ b/manuscript/recipes/nightscout.md @@ -1,3 +1,7 @@ +--- +description: CGM data with an API, for diabetic quality-of-life improvements +--- + # Nightscout Nightscout is "*...an open source, DIY project that allows real time access to a CGM data via personal website, smartwatch viewers, or apps and widgets available for smartphones*" diff --git a/manuscript/recipes/openldap.md b/manuscript/recipes/openldap.md index 1ff8369..34c3926 100644 --- a/manuscript/recipes/openldap.md +++ b/manuscript/recipes/openldap.md @@ -1,3 +1,7 @@ +--- +description: Authenticate like it's 1990! +--- + # OpenLDAP LDAP is probably the most ubiquitous authentication backend, before the current era of "[stupid social sign-ons](https://www.usatoday.com/story/tech/columnist/2018/10/23/how-separate-your-social-networks-your-regular-sites/1687763002/)". Many of the recipes featured in the cookbook (_[NextCloud](/recipes/nextcloud/), [Kanboard](/recipes/kanboard/), [Gitlab](/recipes/gitlab/), etc_) offer LDAP integration. diff --git a/manuscript/recipes/owntracks.md b/manuscript/recipes/owntracks.md index 209dc9f..c42e492 100644 --- a/manuscript/recipes/owntracks.md +++ b/manuscript/recipes/owntracks.md @@ -1,3 +1,7 @@ +--- +description: Spy on yourself. +--- + # OwnTracks [OwnTracks](https://owntracks.org/) allows you to keep track of your own location. You can build your private location diary or share it with your family and friends. OwnTracks is open-source and uses open protocols for communication so you can be sure your data stays secure and private. diff --git a/manuscript/recipes/paperless-ng.md b/manuscript/recipes/paperless-ng.md index f0492f8..06cf1cf 100644 --- a/manuscript/recipes/paperless-ng.md +++ b/manuscript/recipes/paperless-ng.md @@ -1,5 +1,5 @@ --- -description: Paperless NG - Easily index, search, and view archive all of your scanned paper documents +description: Easily index, search, and view archive all of your scanned dead-tree documents --- # Paperless NG diff --git a/manuscript/recipes/photoprism.md b/manuscript/recipes/photoprism.md index 3e136e2..bcd28aa 100644 --- a/manuscript/recipes/photoprism.md +++ b/manuscript/recipes/photoprism.md @@ -1,4 +1,6 @@ -hero: Your own private google photos +--- +description: ML-powered private photo hosting +--- # Photoprism diff --git a/manuscript/recipes/phpipam.md b/manuscript/recipes/phpipam.md index 852e0ba..141aa50 100644 --- a/manuscript/recipes/phpipam.md +++ b/manuscript/recipes/phpipam.md @@ -1,3 +1,7 @@ +--- +description: Is that IP address in use? +--- + # phpIPAM phpIPAM is an open-source web IP address management application (_IPAM_). Its goal is to provide light, modern and useful IP address management. It is php-based application with MySQL database backend, using jQuery libraries, ajax and HTML5/CSS3 features. diff --git a/manuscript/recipes/plex.md b/manuscript/recipes/plex.md index 40ac970..9daf20d 100644 --- a/manuscript/recipes/plex.md +++ b/manuscript/recipes/plex.md @@ -1,4 +1,6 @@ -hero: A recipe to manage your Media πŸŽ₯ πŸ“Ί 🎡 +--- +description: Play back all your media on all your devices +--- # Plex diff --git a/manuscript/recipes/portainer.md b/manuscript/recipes/portainer.md index 33b9e13..e63c585 100644 --- a/manuscript/recipes/portainer.md +++ b/manuscript/recipes/portainer.md @@ -1,4 +1,6 @@ -hero: A recipe for a sexy view of your Docker Swarm +--- +description: A UI to make Docker less geeky +--- # Portainer diff --git a/manuscript/recipes/privatebin.md b/manuscript/recipes/privatebin.md index f873395..e37b247 100644 --- a/manuscript/recipes/privatebin.md +++ b/manuscript/recipes/privatebin.md @@ -1,3 +1,7 @@ +--- +description: A private imgur/pastebin +--- + # PrivateBin PrivateBin is a minimalist, open source online pastebin where the server (can) has zero knowledge of pasted data. We all need to paste data / log files somewhere when it doesn't make sense to paste it inline. With PasteBin, you can own the hosting, access, and eventual deletion of this data. diff --git a/manuscript/recipes/realms.md b/manuscript/recipes/realms.md index 7370eb0..bc5caa3 100644 --- a/manuscript/recipes/realms.md +++ b/manuscript/recipes/realms.md @@ -1,3 +1,7 @@ +--- +description: A git-based wiki with auth and registration +--- + # Realms Realms is a git-based wiki (_like [Gollum](/recipes/gollum/), but with basic authentication and registration_) diff --git a/manuscript/recipes/restic.md b/manuscript/recipes/restic.md index b445b64..71d5f6c 100644 --- a/manuscript/recipes/restic.md +++ b/manuscript/recipes/restic.md @@ -1,3 +1,7 @@ +--- +description: Don't be like Cameron. Back up your shizz. +--- + # Restic Don't be like [Cameron](http://haltandcatchfire.wikia.com/wiki/Cameron_Howe). Backup your stuff. diff --git a/manuscript/recipes/rss-bridge.md b/manuscript/recipes/rss-bridge.md index 5f1558b..a10b6cb 100644 --- a/manuscript/recipes/rss-bridge.md +++ b/manuscript/recipes/rss-bridge.md @@ -1,5 +1,8 @@ -# RSS Bridge +--- +description: Stalk your ex on Facebook in your feedreader! +--- +# RSS Bridge Do you hate having to access multiple sites to view specific content? [RSS-Bridge](https://github.com/RSS-Bridge/rss-bridge) can convert content from a wide variety of websites (*such as Reddit, Facebook, Twitter*) so that it can be viewed in a structured and consistent way, all from one place (Your feed reader) diff --git a/manuscript/recipes/swarmprom.md b/manuscript/recipes/swarmprom.md index 242d149..d225d6d 100644 --- a/manuscript/recipes/swarmprom.md +++ b/manuscript/recipes/swarmprom.md @@ -1,3 +1,7 @@ +--- +description: Data is beautiful +--- + # Swarmprom [Swarmprom](https://github.com/stefanprodan/swarmprom) is a starter kit for Docker Swarm monitoring with [Prometheus](https://prometheus.io/), [Grafana](http://grafana.org/), [cAdvisor](https://github.com/google/cadvisor), [Node Exporter](https://github.com/prometheus/node_exporter), [Alert Manager](https://github.com/prometheus/alertmanager) and [Unsee](https://github.com/cloudflare/unsee). And it's **damn** sexy. See for yourself: diff --git a/manuscript/recipes/template.md b/manuscript/recipes/template.md index b87a6a2..23be6a5 100644 --- a/manuscript/recipes/template.md +++ b/manuscript/recipes/template.md @@ -1,5 +1,5 @@ --- -description: Neat 😘 one-sentence description of recipe for social media previews +description: Neat one-sentence description of recipe for social media previews --- # diff --git a/manuscript/recipes/tiny-tiny-rss.md b/manuscript/recipes/tiny-tiny-rss.md index e7cbdbe..98555a0 100644 --- a/manuscript/recipes/tiny-tiny-rss.md +++ b/manuscript/recipes/tiny-tiny-rss.md @@ -1,3 +1,7 @@ +--- +description: Geeky RSS reader +--- + # Tiny Tiny RSS [Tiny Tiny RSS](https://tt-rss.org/) is a self-hosted, AJAX-based RSS reader, which rose to popularity as a replacement for Google Reader. It supports ~~geeky~~ advanced features, such as: diff --git a/manuscript/recipes/wallabag.md b/manuscript/recipes/wallabag.md index dbf8b39..8d19ea7 100644 --- a/manuscript/recipes/wallabag.md +++ b/manuscript/recipes/wallabag.md @@ -1,4 +1,6 @@ -hero: Read-it-later, mate! +--- +description: Read-it-later, mate! +--- # Wallabag diff --git a/manuscript/recipes/wekan.md b/manuscript/recipes/wekan.md index b83f398..cca7ca7 100644 --- a/manuscript/recipes/wekan.md +++ b/manuscript/recipes/wekan.md @@ -1,3 +1,7 @@ +--- +description: A self-hosted Trello +--- + # Wekan Wekan is an open-source kanban board which allows a card-based task and to-do management, similar to tools like WorkFlowy or Trello. diff --git a/manuscript/recipes/wetty.md b/manuscript/recipes/wetty.md index 14bfbb8..dc4de6f 100644 --- a/manuscript/recipes/wetty.md +++ b/manuscript/recipes/wetty.md @@ -1,4 +1,6 @@ -hero: Terminal in a browser, baby! πŸ’» +--- +description: Terminal in a browser, baby! +--- # Wetty diff --git a/mkdocs.yml b/mkdocs.yml index a57d945..42e761d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -199,7 +199,6 @@ theme: - navigation.indexes - navigation.top - search.suggest - - search.highlight - search.share icon: repo: 'fontawesome/brands/github'