diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 87abc36..4b1e78a 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -61,6 +61,20 @@ export default defineConfig({ link: '/configure/sql/postgresql' } ] + }, + { + text: 'Clients', + link: '/configure/clients', + items: [ + { + text: 'ShareX', + link: '/configure/clients/sharex' + }, + { + text: 'Flameshot', + link: '/configure/clients/flameshot' + } + ] } ] }, diff --git a/docs/configure/clients/flameshot.md b/docs/configure/clients/flameshot.md new file mode 100644 index 0000000..789591f --- /dev/null +++ b/docs/configure/clients/flameshot.md @@ -0,0 +1,11 @@ +# Flameshot + +The Flameshot script has been updated to be a lot more dynamic, including adding support for [cheek](https://github.com/tycrek/cheek#readme), my serverless ShareX upload server. To set cheek mode, edit the file [`flameshot-v2.sh`](https://github.com/tycrek/ass/blob/dev/0.15.0/flameshot-v2.sh) and set `MODE=0` to `MODE=1`. + +To set your token (not in use yet, can be random) and domain for the script, create these directories with the following files: + +- `~/.ass/` (or `~/.cheek/`) +- `~/.ass/.token` +- `~/.ass/.domain` + +For `.domain`, you do **not** need to include `http(s)://`. diff --git a/docs/configure/clients/sharex.md b/docs/configure/clients/sharex.md new file mode 100644 index 0000000..e811bd3 --- /dev/null +++ b/docs/configure/clients/sharex.md @@ -0,0 +1,10 @@ +# ShareX + +| Setting | Value | +| ------- | ----- | +| Request URL | Your server domain (including `http(s)://`) | +| Request Method | `POST` | +| Destination Type | `Image`, `Text`, `File` | +| Body | `multipart/form-data` | +| File Form Name | `file` | +| URL | `{json.resource}` | diff --git a/docs/configure/index.md b/docs/configure/index.md new file mode 100644 index 0000000..2ab8b3b --- /dev/null +++ b/docs/configure/index.md @@ -0,0 +1,25 @@ +# Configure + +Most of the configuration is managed through the administrator dashboard. + +## `server.json` overrides + +The webserver in ass 15 is hosted independently of any user configuration. If you wish to set a specific server setting, you may do so with a `server.json` file. + +Place this file in `/.ass-data/`. + +| Property | Use | Default | +| -------- | --- | ------- | +| `host` | Local IP to bind to | `0.0.0.0` | +| `port` | Port to listen on | `40115` | +| `proxied` | If ass is behind a reverse proxy | `false`, unless `NODE_ENV=production` is specified, otherwise `true` | + +**Example** + +```json +{ + "host": "127.0.1.2", + "port": 40200, + "proxied": false +} +```