The ADMIN_EMAIL and ADMIN_PASSWORD variables are not documented in README.md or .env.example #227

Closed
opened 2026-04-05 16:17:09 +02:00 by MrUnknownDE · 0 comments
Owner

Originally created by @millermarkj on 9/13/2025

I just stood up a new instance of this and could not figure out where on earth I was supposed to add admin credentials for the initial login. They are not documented in either README.md or .env.example.

It was only after searching for openarchiver via a search engine that I found openarchiver.com, and from there clicked Resources -> Docs, and from there clicked Installation Guide and scrolled down to section 4 that I was able to find the information I needed to use the application.

This should be documented in .env.example at minimum, and a slightly more comprehensive list of "required" variables should be added to README.md. In addition, if the documentation is not directly on github, there should be a link to the documentation from README.md.

*Originally created by @millermarkj on 9/13/2025* I just stood up a new instance of this and could not figure out where on earth I was supposed to add admin credentials for the initial login. They are not documented in either README.md or .env.example. It was only after searching for openarchiver via a search engine that I found openarchiver.com, and from there clicked Resources -> Docs, and from there clicked Installation Guide and scrolled down to [section 4](https://docs.openarchiver.com/user-guides/installation.html#_4-access-the-application) that I was able to find the information I needed to use the application. This should be documented in .env.example at minimum, and a slightly more comprehensive list of "required" variables should be added to README.md. In addition, if the documentation is not directly on github, there should be a link to the documentation from README.md.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github/OpenArchiver#227