Documentation system for IT infrastructure

Hi together,

after googling my ass wound, I‘m wondering if you‘ve got some ideas what could fit my needs.
As an admin I‘m in the need to store information about customers, like IP addresses and ranges, their credentials, possibly user credentials and software licenses (perpetual and recurring), maybe even hardware information etc.

Are you aware of sth like that? Snipe-IT doesn’t seem to be an option as it does still not support subscription based licenses (why ever…) and GLPI is not tenancy based.

Thanks in advance!

DigitalOcean Netbox, it’s a IPAM and DCIM solution, with note abilities so you can notate stuff, and if I remember correctly it supports software inventory kind of too (although I never used it)

You absolutely should not store credentials in anything other than a password manager like Bitwarden or Keeper though.

At work we use Logseq for notes and we store software licenses in vaultwarden.

I also have all of the docker compose files and other required files in a git repository with a readme per compose stack.

Dokuwiki is the way to go! Custom make all the pages using tables, etc.

So what we’re looking at is probably two or three systems here. I can’t help you on what systems integrate.

Documentation

This is for general documentation. SOPs, etc.

I generally advise documentation be stored in Markdown. This is after decades of having to migrate systems or being locked into a documentation system because a migration path was too timely.

Markdown is ultra portable and easy to store/backup. You can get change management interfaces for it, or store it in Git if you have to.

Even something like mdwiki would do the trick in a pinch. The value you see out of this lies in how well you keep it organized and how well you use it.

Client Secrets

This will be served by a secrets manager like https://github.com/Infisical/infisical

I’ve never used it but I’ve seen it recommended and it seems like a good project.

I’ve used things like KeePass, Bitwarden andOnePass. My preference would probably be none of them, but I do like Bitwarden for a personal vault.

Asset Management

This should be handled by an asset management system. This is for things like licenses, hardware, etc.

Snipe-IT was actually my pick for this. Just for assets though, nothing else.

after googling my ass wound

say what now?

“After googling my ass wound” is not something I expected to hear today, but here we are

Netbox for IPAM and DCIM, Vaultwarden for passwords, snipe-it for assets, and wikijs for documentation.

Most of it resembles Confluence that is a popular documentation platform in the IT world…

Check out the client management documentation for ITFlow.

https://docs.itflow.org/

It’s modularized so you can turn off the parts you don’t need, like accounting or ticketing.

after googling my ass wound

WTF did you say?

Probably not your case, but that’s what I use for my homelab:

  • OIDplus for keeping OIDs, IPs, .home.arpa subdomains etc
  • local-only Wordpress as a knowledgebase. Today I’d probably chose Bookstack, but it did not exist 11 years ago…

Another vote for Bookstack. We’ve been using it in a business for years now. Easy to setup and configure. Easy to use. Just works.

So, first of all, thank you all so much for your input; I really appreciate it!!
Secondly, I‘m sorry for that confusing term of „googling my ass wound“, that’s kind of a terrible translation from german, but y‘all got the point :smiley:

I’m going to upvote every answer as I’m really thankful to discuss about that topic. A secure stack, looking at secrets and passwords, it’s definitely wise to split that between the documentation itself and something that’s build for passwords like Bitwarden.

I’m looking forward to try ITFlow because it’s looking like the combination I searched for, but hidden behind VPN as it’s still beta and they are not sure if there are security concerns for themselves.

So long story short: thanks and keep hosting your own stuff!

I’ve been wanting to build a system just like this for a while. I started just jotting down all the information in a wiki and then never found any benefit from building a more structured system that the simple wiki already provides.

Happy to discuss in further detail, maybe even talk about prototyping something basic if you have some good suggestions.

Take time to read/try/learn about Netbox, it should be perfect for you.

At Work, I deployed Netbox and, even if the teams were reluctant at first, they finally saw the benefits and slowly gave up their infamous excel sheets :wink:

For general documentation and scripts, I tried to push people to MKdocs-material automatically updated from a Gitea repository but people are too allergic to Markdown…

I should have pushed Bookstack as it’s more user friendly…

For passwords and sensitive info, we use Vaultwarden. It’s perfect and you even have an API to query it for your script credentials.

Do not hesitate to ask for any more info.

Hudu , Docusnap, Gira.

We use Hudu, but for us it´s limited in function.

probably (with using Yubikey for github ssh encryption amd gpg)

  1. vscode MarkDown and github.
  2. mdbook, however you will have to install mdbook-katex for Katext formula.
  3. passwordstore
  4. Pass simple download | SourceForge.net if you wan’t templates and YAML with passwordstore.

Legacy commercial options

  1. Lotus notes
  2. Microsoft Sharepoint

Hudu is what I use and it’s amazing

Anyone else ever heard of (or using) iTop?