Basic usage of Tiny Wiki is very straightforward. The Home page of the Wiki that gets created automatically when the server is first run contains the same usage instructions as this guide page.

• Use Edit to modify the page you are currently viewing.
• Create new articles with New Page.
• Provide links to other Wiki pages using [[AnotherPage]].
• Browse everything via All Pages.

These configuration options are available by setting environment variables in the settings.toml file.

• WIKI_TITLE: The title to show at the top of all pages.
• WIKI_PAGES_DIR: The directory to store page files. "/sd/pages" by default. Must be writable.
• WIKI_SERVER_PORT: The HTTP port to host the server on. Defaults to 8000
• WIKI_AUTH_DATA_FILE: Optional path to JSON file containing valid user(s) authentication details. Defaults to None (auth disabled).
• WIKI_PASSWORD_SALT: Pepper used when hashing passwords if auth is enabled. You should change it from the default value.
• WIKI_AUTH_SECRET_KEY: Key string used when hashing values to derive session tokens if auth is enabled. You should change it from the default value.

The authentication system is optional, and disabled by default. If enabled it will require logging in with valid credentials in order to create, update, or delete Wiki pages.

To enable authentication, create a JSON file on the CIRCUITPY drive and set the path to it as the value for WIKI_AUTH_DATA_FILE environment variable.

For example in settings.toml:

WIKI_AUTH_DATA_FILE="wiki_auth.json"

Go to the Credential Hash page in your browser, enter the desired username and password, and click Generate Hash. Copy the resulting username/hash JSON object into the auth data file mentioned above. It can contain either a single entry with one object containing a username and hash, or a list of objects containing usernames and hashes. Single user example:

{"password_hash": "dbd1bdabd1c22032e7cb64217cc9d4bca7242f68bfba46aa0b9418a58138304f", "username": "wiki_user"}

Multiple user example:

[
  {"password_hash": "3eb1d64cde9d156c852dab00bccf9194932ed6e540a61f2bd53fdf1c03044dac", "username": "wiki_user"},
  {"password_hash": "12cdd16b8cec46aa1defc576342aaef5c0dd0773ba5c8a0c3a726c3ee56cd50f", "username": "test_user"}
]