39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# WriteFreely
|
|
|
|
WriteFreely is a minimalist, federated blogging platform built on ActivityPub.
|
|
|
|
## Dependencies
|
|
|
|
- **MySQL** - Database for storing posts and accounts
|
|
|
|
## Configuration
|
|
|
|
Key settings in `config.yaml`:
|
|
|
|
- **domain** - Where WriteFreely will be accessible
|
|
- **storage** - Persistent volume size (default: `1Gi`)
|
|
- **siteName** - Display name for the instance (default: `WriteFreely`)
|
|
- **adminUser** - Admin username (default: `admin`)
|
|
|
|
## First-Time Setup
|
|
|
|
1. Add and deploy the app:
|
|
```bash
|
|
wild app add writefreely
|
|
wild app deploy writefreely
|
|
```
|
|
|
|
2. Log in at `/admin/login` with:
|
|
- **Username**: value of `adminUser` in your config (default: `wildadmin`)
|
|
- **Password**: value of `adminPassword` in your `secrets.yaml`
|
|
|
|
Note: WriteFreely reserves the username `admin` — the default and any configured `adminUser` must not be `admin`.
|
|
|
|
3. From the admin dashboard you can manage users, customize the instance, and create your first blog.
|
|
|
|
## Notes
|
|
|
|
- Each user gets their own blog at `/{username}`
|
|
- ActivityPub federation allows posts to be followed from Mastodon and other fediverse platforms
|
|
- New user registration can be enabled or restricted via the admin dashboard
|