135 lines
4.5 KiB
Markdown
135 lines
4.5 KiB
Markdown
# f0ckm
|
|
|
|
Happy to finally bring you f0ckm! The long awaited imageboard solution that you can host yourself. It is designed to be a real alternative to big tech platforms that you can modify to suit your communities needs.
|
|
|
|
It features extensive tagging, searching, filtering and a variety of options.
|
|
|
|
The software is mostly generic, it can be modified easily via `config.yaml` (or `config.json`) to suit your communities needs. Most things can be enabled/disabled very easily and modified to needs.
|
|
|
|
The software comes without any warranties or entitlements of any kind! The developer is not responsible for anything you do with the use of this software.
|
|
|
|
## Software Requirements
|
|
|
|
- Docker (https://docs.docker.com/engine/install/debian/)
|
|
|
|
## prod
|
|
|
|
first things
|
|
|
|
`cp .env.example .env`
|
|
|
|
fill with for example: f0ckm (prefilled)
|
|
|
|
Copy example configuration and customize:
|
|
|
|
`cp config_example.yaml config.yaml`
|
|
`npm run config:gen`
|
|
|
|
(Or `cp config_example.json config.json` if configuring directly in JSON)
|
|
|
|
Edit to needs, for sql you can do this:
|
|
|
|
host can either be localhost or the docker containers hostname, when running via docker this must be the dockers hostname, if you choose localhost you wont need to add the ENV `DB_HOST=localhost` and if you also change the port to be `DB_PORT=5454` you wont need this ENV either, but then Docker wont find the DB.
|
|
|
|
```
|
|
"sql": {
|
|
"host": "f0ckm-db",
|
|
"port": 5432,
|
|
"user": "f0ckm",
|
|
"password": "f0ckm",
|
|
"database": "f0ckm",
|
|
"multipleStatements": true,
|
|
"max": 50
|
|
},
|
|
```
|
|
|
|
`docker compose up -d`
|
|
|
|
`docker exec -i f0ckm-db psql -U f0ckm -d f0ckm < migrations/f0ckm_schema.sql`
|
|
|
|
`docker exec -t f0ckm node scripts/seed.mjs`
|
|
|
|
`docker exec -t f0ckm node scripts/create-admin.mjs admin 'YOUR_PASSWORD_HERE'`
|
|
|
|
For regular building after making changes to the source code
|
|
|
|
`bash build.bash master`
|
|
|
|
now vist http://localhost:1337 in your browser
|
|
|
|
## dev
|
|
|
|
NOTE: when developing locally it might be necessary to run commands with `DB_HOST=localhost DB_PORT=5454`
|
|
|
|
`docker compose up -d f0ckm-db`
|
|
|
|
on dev machine:
|
|
|
|
`npm i`
|
|
`npm run dev`
|
|
|
|
Fill Database
|
|
|
|
`docker exec -i f0ckm-db psql -U f0ckm -d f0ckm < migrations/f0ckm_schema.sql`
|
|
|
|
`DB_HOST=localhost DB_PORT=5454 node scripts/seed.mjs`
|
|
|
|
Create admin user in dev env
|
|
|
|
`DB_HOST=localhost DB_PORT=5454 node scripts/create-admin.mjs admin 'YOUR_PASSWORD_HERE'`
|
|
|
|
now visit http://localhost:1337 in your browser, you can develop without needing to rebuild the docker image for every change
|
|
|
|
## Configuration Management
|
|
|
|
You can manage configuration in YAML (`config.yaml`) or JSON (`config.json`):
|
|
- `npm run config:gen`: Compiles `config.yaml` to `config.json`. Automatically runs before `npm run dev` and `npm start`.
|
|
- `npm run config:watch`: Watches `config.yaml` for edits and recompiles `config.json` automatically on save.
|
|
- `npm run config:to-yaml`: Converts existing `config.json` into `config.yaml`.
|
|
|
|
## NGINX
|
|
|
|
uncomment in .env # COMPOSE_PROFILES=f0ckm-nginx to enable nginx proxy with automatic lets encrypt.
|
|
|
|
## Tor Hidden Service (.onion)
|
|
|
|
Tor is bundled in `docker-compose.yml` and preconfigured as long as COMPOSE_PROFILES=f0ckm-tor is set with a hidden service pointing to the application (`f0ckm:1337`).
|
|
|
|
When running `docker compose up -d`, Tor automatically generates a `.onion` address for your node. You can find your onion address by running:
|
|
|
|
```bash
|
|
cat ./f0ckm-data/tor/f0ckm_hs/hostname
|
|
```
|
|
|
|
### Automatic Onion-Location Header
|
|
|
|
To advertise your `.onion` address to Tor Browser users visiting your clearnet site, add your `.onion` address to `config.json`:
|
|
|
|
```json
|
|
"main": {
|
|
"onion": "http://yourgeneratedaddress.onion"
|
|
}
|
|
```
|
|
|
|
## Chat uploads (temporary file hosting for mumh5)
|
|
|
|
Upload-only API keys for external chat clients. Files are public, never appear on the imageboard, and expire (default 30 days, see `chat_upload_*` in `config.yaml`).
|
|
|
|
Manage keys (the key is shown once, only its hash is stored):
|
|
|
|
`node scripts/chat-upload-key.mjs create <name> [max_mb]`
|
|
`node scripts/chat-upload-key.mjs list`
|
|
`node scripts/chat-upload-key.mjs revoke <id>`
|
|
|
|
Upload (raw body, returns JSON with `url` and `delete_token`):
|
|
|
|
```bash
|
|
curl -X POST https://your.host/api/chat/upload \
|
|
-H "X-API-Key: cu_..." -H "X-Filename: clip.webm" -H "X-Upload-Expiry: 7d" \
|
|
--data-binary @clip.webm
|
|
```
|
|
|
|
Delete: `curl -X DELETE https://your.host/api/chat/upload/<slug> -H "X-Delete-Token: ..."`
|
|
|
|
Files are served at `/cu/<slug>/<name>` with Range support. Only sniffed images, video and audio are served inline; anything else is forced to download.
|