Feedback about the documentation
This is what I experienced as a new user. I'm not great at communicating like this so don't take it as rudeness please.
The Linux instructions say to launch the binary with ./homebox but that leads to the following error and the top search results are all for API References.
panic: auth.api_key_pepper must be set to at least 32 bytes; generate with `openssl rand -base64 48` and provide via HBOX_AUTH_API_KEY_PEPPER. Rotating it invalidates all issued API keys
The Configure page has a tab for the CLI Option --auth-api-key-pepper but the instructions below that are only for systemd installs, not for using the binary like the installation page says you can do.
I didn't test that because I'm using Aurora OS and really only want to launch it as needed like an app. I created the api key and launched the binary successfully, but it's apparently not persistent and I need to create a sh file.
I register and click to create an item. The only entity option is "Location" which I know isn't what I want to use. I go to the page for User Guide/Items. Nothing here explains that you have to create an entity before creating an item. It states that, "Items and locations are both entities in Homebox, differentiated by their entity type." But that link goes to a 404 page.
My point is that I think the install and usage instructions could use some clarifications. Obviously I eventually figured everything out through common sense and trial and error. Thank you.
2 replies
Thanks for the feedback. I think the entity type link not working is my fault, we'll definitely add a page on them. There should be an Item entity auto created but there is a bug in the latest release where it sometimes doesn't, this should be fixed in the next release. Homebox can load cli options from a file though I do believe you need to use a cli option for that, I definitely think we can improve the usability and documentation around that.
Good to know, thank you. I forgot to mention that I did do an issue search for "entity" before. But thanks to my inexperienced eye nothing seemed to match closely enough and why I chose not to open an issue there. I really appreciate you taking the time to respond so thoughtfully.