diff --git a/documentation/.vitepress/config.mts b/documentation/.vitepress/config.mts index 5e315f8..3f1c502 100644 --- a/documentation/.vitepress/config.mts +++ b/documentation/.vitepress/config.mts @@ -113,6 +113,10 @@ export default defineConfig({ text: "Guides", collapsed: false, items: [ + { + text: "Admin Panel", + link: "/docs/guides/admin_panel", + }, { text: "v0.7.1 Migration Guide", link: "/docs/guides/v0-7-1_migration", diff --git a/documentation/docs/guides/admin_panel.md b/documentation/docs/guides/admin_panel.md new file mode 100644 index 0000000..bd13d66 --- /dev/null +++ b/documentation/docs/guides/admin_panel.md @@ -0,0 +1,11 @@ +# AdventureLog Admin Panel + +The AdventureLog Admin Panel, powered by Django, is a web-based interface that allows administrators to manage objects in the AdventureLog database. The Admin Panel is accessible at the `/admin` endpoint of the AdventureLog server. Example: `https://al-server.yourdomain.com/admin`. + +Features of the Admin Panel include: + +- **User Management**: Administrators can view and manage user accounts, including creating new users, updating user information, and deleting users. +- **Adventure Management**: Administrators can view and manage adventures, including creating new adventures, updating adventure information, and deleting adventures. +- **Security**: The Admin Panel enforces access control to ensure that only authorized administrators can access and manage the database. This means that only users with the `is_staff` flag set to `True` can access the Admin Panel. + +Note: the `CSRF_TRUSTED_ORIGINS` setting in your `docker-compose.yml` file must include the domain of the server. For example, if your server is hosted at `https://al-server.yourdomain.com`, you should add `al-server.yourdomain.com` to the `CSRF_TRUSTED_ORIGINS` setting.