selfhostedshow/wiki

The official Wiki of the selfhosted.show Podcast.

selfhostedshow/wiki

This repository contains the backend for the Self-Hosted podcast wiki.

Usage

Start development server

docker-compose up

Then open your browser to http://localhost:8000

Build documentation

Sometimes, you just want to output the HTML into a directory, rather than use the development server.

docker-compose run wiki build

The site will then be output into the site/ directory.

Contribution Template

The file contribution-template.md has been provided as a sample and possible starting point. It is located along with this README file. Feel free to copy and use the template.

wiki's Issues

Article on docker

• installation
• docker-compose
• containers
• linuxerver.io

Use/Link Ressources from the Linuxserver.io blog

The Linuxserver.io blog already has great articles like Let's Encrypt, Nginx & Reverse Proxy Starter Guide - 2019 Edition available. Wouls it be possible to reference to this articles or make pages based on these?

Utilizing CI/CD.

How gitlab CI or Gitea/Drone can simplify your self-hosted setup.

Article on Server Management

• What is a server?
• What is Headless?
• remote management
  • ssh
  • vnc

Article on Git servers

Possible servers to include:

• Gitea
• Gogs
• GitLab
• cgit / gitweb?

Possible points

• Gitea vs GitLab
• Benefits of cgit / gitweb

Article on Git

Writing an article on Git including

• Use cases for git
• Cloning a repo
• Creating Commits
• Branches
• Pushing to remote

Article on Mumble

I'd like to know how jupiter broadcasting has setup mumble so I can set up it up in a similar way.

• What plugins, bots and custom scripts do you use?
• Do you use Jack to manage users in queue via multiple instances?
• How do you integrate mumble into your podcast?
• Is much administration needed?

Provide new Canonical reference for a personal Article / Google Search Engine

We often write our own blog posts. But we also want to share our content and attract more traffic to our sites. As well as avoiding issues with Google Search down grading our posts because of duplication.

I would like to propose that we add the ability for the wiki to provide an alternate canonical link reference.

This would be done though the use of two meta items in the markdown file.

---
template: canonical.html
canonical: https://some-reference-to-original-post/
---

Original article content goes here.

This produces the resulting header code

    --snip--
    <link href=https://some-reference-to-original-post/ rel=canonical>
    <link rel="shortcut icon" href=../img/favicon.ico>
    <title>Test - Self-Hosted Show Wiki</title>
    <link rel=stylesheet href=../assets/stylesheets/main.6910b76c.min.css>
    <link rel=stylesheet href=../assets/stylesheets/palette.196e0c26.min.css>
    <link href=https://fonts.gstatic.com rel=preconnect crossorigin>
    <link rel=stylesheet href="https://fonts.googleapis.com/css?family=Ubuntu:300,400,400i,700%7CUbuntu+Mono&display=fallback">

This produces the resulting page.

Of course the original canonical reference can be used by not having the canonical: reference. Or by not using the new template.
Everything fails back gracefully.

The thinking behind this is it might encourage people to share their write ups on projects and help with Google Search.

I would ask for thoughts and feed back.

Article: Setup a Github workflow that causes GitHub to push to an external git repo.

This article in pull request #108 show how to configure a workflow in such a way that is can use the checkout action to push to a remote server using ssh keys

contributing.md vs CONTRIBUTING.md

not sure if this is correct or not but it looks like docs/wiki/contributing.md is just a link to CONTRIBUTING.md should CONTRIBUTING.md replace contributing.md? as i dont see any of the other files linked just trying to keep everything the same.

Article on Linux

• Everything is a File
• command line
  • navigation
  • files
  • permissions
• why Linux
• Installation
• other resources

is this a dup?

https://github.com/selfhostedshow/wiki/blob/dev/docs/home-automation/tasmota/tasmota.md see index.md in the same location

Broken link https://selfhostedshow.github.io/wiki/contributing/ and additional ( character

Broken link:
docs->basics->beginners-contributing-guide.md

See the [Contribution Guidelines]((https://selfhostedshow.github.io/wiki/contributing/) for information and objectives of the wiki

should be

See the [Contribution Guidelines](https://selfhostedshow.github.io/wiki/contributing/) for information and objectives of the wiki

Link also returns a 404 error since this does not appear to exist within the wiki anymore.

Reference awesome-selfhosted

In my opinion Awesome-selfhosted should be referenced somewhere. There is already the link in the page about wikis, but there should be a reference on a more prominent page.

I would suggest one (or multiple) of the following locations:

• The main page (but I think it wouldn't fit there)
• Basic/Basics
• Self hosted apps main page (Doesn't exist yet; I don't know if this is supported by MkDocs or other tools)

I'm happy create a pull request, but would like to discuss a proper place first :)

wiki/auto deploy: Update for new process

Hi,
I was reading up on how the wiki is deployed. Step 5 seems to have stopped mid-sentence.

CONTRIBUTING.md potential link failure / docker restarted needed after update.

I was taking a look at CONTRIBUTE.md because of #74 and #75
I have not made any changes. But it looks to me that

See the [Beginners Contributing Guide](https://selfhostedshow.github.io/wiki/basics/beginners-contributing-guide/) for step by step instructions on how to add content.

This hardcode reference might be an issue down the line.

Also, because this file is referenced using {!../CONTRIBUTING.md!} in wiki/contributing.md any changes to the file require a restart of the docker image. I would propose that CONTRIBUTING.md physically be moved and no longer referenced.

Thoughts?

Beginners contributing guide

The contributing guide already contains a great high-level guide on how to get started with contributing. But it'd be great for there to be something more beginner friendly.

https://guides.github.com/ is a great resource for things like this!

As mentioned in https://selfhosted.show/15.

ext4 may NOT be okay for SnapRAID parity

This page has the following note
https://wiki.selfhosted.show/tools/snapraid-btrfs/

Note that although there's no harm with using BTRFS for the SnapRAID parity, there isn't any benefit from doing so to use snapraid-btrfs. It is recommended to use ext4 for the SnapRAID parity.

From the SnapRAID FAQ:

ext4 OK if the disks are NOT bigger than 16 TB. The parity is stored in a single big file, and ext4 has a upper limit of 16 TB for file size.

Drives larger than 16TB have become quite common. It would be quite a nasty surprise running into this hard limit only after your parity file has reached such a massive size.

Article on Home Network

• Home Router functions
  • router
  • modem
  • dhcp server
  • dns server
  • Access point
  • Network switch
• IP addresses
• Network Address Translation
• Vlans
• firewalls

Article on monitoring

Monitoring your applications.

Possible applications

• https://statping.com/
• https://www.nagios.org/
• https://icinga.com/

Possible points

• Why you might not want to selfhost all of this (yes, really!)

Two versions of beginners-contributing-guide.md and out of sync with each other.

There are two versions of beginners-contributing-guide.md one located at docs/basics and another at docs/wiki

These are clearly meant to be the same file. I would propose that one be chosen to be the holder of truth and the other converted to a reference similar to how CONTRIBITING.md is used for docs/wiki/contribiting.md
It appears that wiki/beginners.... is the most up to date and is inline with the move from dev to master for the default branch.

This would allow for the two references. But the need to only edit a single file.

DNS Guide Debian-Stretch

Hi,
I recently posted on the discord forum regarding writing a guide on DNS configuration.

I have been working on it as time permits.

It is still a work in progress.

If there are no issues. I hope to be able to make a pull request after some further proof reading and corrections.

If anyone wants to take a look while I work on it. You can find it at here

Self-host the wiki

For we are not hypocrites, we should be self-hosting this wiki! The intention is to host the web service itself, and CI further down the line, not the Git repo itself.

• Allow the wiki to be run with a production-grade docker container (#18)
• Ensure the docker container is easily accessible (GitHub's registry requires auth, even for public containers, so isn't ideal)
• Get some server space (on hold)
• Configure deployment (https://github.com/selfhostedshow/infrastructure)
• Setup DNS

Related: #40

Article on ansible

Beginner article on ansible
Why it's useful
What it can be used for
How to use it

30s links are broken

links on the bottom of the page in the contribution-template.md 404, need to remove them or replace them.

Article on Nextcloud

Nextcloud, that thing which everyone on /r/selfhosted loves!

Self host this repo?

I was wondering if you have considered self hosting this git repo, rather than relying on Microsoft's GitHub.

I understand that GitHub is great for discoverability, so perhaps mirroring a repo here would be a good idea, but there are a lot of really great self hosted git solutions out there.

I am in the process of moving my repos over to Gitea.

There are obviously others

Article and Example: Pushing to a remote Git Repo use hook to trigger script.

Pull request #109 show how to setup a remote git repo, not Github, as a bare repo and configure a post-receive script to carry out actions.

Article on jitsi

how to host jitsi

cant search other language

can't search in Chinese, is there any solution for it?

Consider Vuepress

Over mkdocs or Hugo. https://vuepress.vuejs.org/

Still just uses markdown. If there's interested I'll throw together a quick PR.