Skip to content
This repository has been archived by the owner on Dec 19, 2024. It is now read-only.

Commit

Permalink
docs: migrate some data from PR
Browse files Browse the repository at this point in the history
  • Loading branch information
tycrek committed Dec 4, 2023
1 parent 4727913 commit 1bb79c9
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
]
}
]
},
Expand Down
11 changes: 11 additions & 0 deletions docs/configure/clients/flameshot.md
Original file line number Diff line number Diff line change
@@ -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)://`.
10 changes: 10 additions & 0 deletions docs/configure/clients/sharex.md
Original file line number Diff line number Diff line change
@@ -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}` |
25 changes: 25 additions & 0 deletions docs/configure/index.md
Original file line number Diff line number Diff line change
@@ -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 `<root>/.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
}
```

0 comments on commit 1bb79c9

Please sign in to comment.