40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# BookStack
|
|
|
|
BookStack is a simple, self-hosted platform for organising and storing information in a hierarchical structure of Books, Chapters, and Pages.
|
|
|
|
## Dependencies
|
|
|
|
- **MySQL** - Database for storing content and users
|
|
- **SMTP** - For email notifications and password resets
|
|
|
|
## Configuration
|
|
|
|
Key settings in `config.yaml`:
|
|
|
|
- **domain** - Where BookStack will be accessible
|
|
- **storage** - Persistent volume size (default: `2Gi`)
|
|
- **db.name** - Database name (default: `bookstack`)
|
|
- **smtp** - Email settings inherited from your Wild Cloud SMTP service
|
|
|
|
## First-Time Setup
|
|
|
|
1. Add and deploy the app:
|
|
```bash
|
|
wild app add bookstack
|
|
wild app deploy bookstack
|
|
```
|
|
|
|
2. Log in with the default admin credentials:
|
|
- **Email**: `admin@admin.com`
|
|
- **Password**: `password`
|
|
|
|
3. **Immediately change the admin email and password** via **Settings → Your Profile**.
|
|
|
|
4. Start creating Books, Chapters, and Pages from the dashboard.
|
|
|
|
## Notes
|
|
|
|
- BookStack uses the linuxserver.io image which runs as root internally — this is expected and required for the image to function
|
|
- SMTP settings are configured via the `smtp` section in your config
|
|
- The `appKey` secret is auto-generated and used for encrypting data — do not change it after content has been created
|