this post was submitted on 28 Jul 2023
137 points (95.4% liked)

Selfhosted

39247 readers
358 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

Rules:

  1. Be civil: we're here to support and learn from one another. Insults won't be tolerated. Flame wars are frowned upon.

  2. No spam posting.

  3. Posts have to be centered around self-hosting. There are other communities for discussing hardware or home computing. If it's not obvious why your post topic revolves around selfhosting, please include details to make it clear.

  4. Don't duplicate the full text of your blog or github here. Just post the link for folks to click.

  5. Submission headline should match the article title (don’t cherry-pick information from the title to fit your agenda).

  6. No trolling.

Resources:

Any issues on the community? Report it using the report flag.

Questions? DM the mods!

founded 1 year ago
MODERATORS
137
submitted 1 year ago* (last edited 1 year ago) by [email protected] to c/selfhosted
 

My home lab has a mild amount of complexity and I'd like practice some good habits about documenting it. Stuff like, what each system does, the OS, any notable software installed and, most importantly, any documentation around configuration or troubleshooting.

i.e. I have an internal SMTP relay that uses a letsencrypt SSL cert that I need to use the DNS challenge to renew. I've got the steps around that sitting in a Google Doc. I've got a couple more google docs like that.

I don't want to get super complicated but I'd like something a bit more structured than a folder full of google docs. I'd also like to pull it in-house.

Thanks

Edit: I appreciate all the feedback I've gotten on this post so far. There have been a lot of tools suggested and some great discussion about methods. This will probably be my weekend now.

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 2 points 1 year ago (2 children)

Why not push it up to GitHub? Then you also get a commit history to see your changes overtime.

[–] [email protected] 2 points 1 year ago (2 children)

Wow that sounds convinient, where can i find a guide describing this? Has zero experience with git 😅

[–] cpo 2 points 1 year ago

There are tons of tutorials around, but the basic gist is that you only use a couple of commands (or even a good frontend) in git, especially when it's a one (wo)man show.

I highly recommend it!

[–] [email protected] 1 points 1 year ago

Gotcha. Git is useful in so many way, but it can be confusing to learn. I don’t have a guide on hand but searching for ‘getting started with git’ will get you pretty far.

Another great way to do this that I just thought of this second is using Notion. It is in markdown.

[–] [email protected] 1 points 1 year ago

Seems a lot of people are doing that.