pict-rs/README.md

385 lines
14 KiB
Markdown
Raw Normal View History

2020-06-07 02:01:04 +00:00
# pict-rs
_a simple image hosting service_
2021-02-11 01:38:42 +00:00
## Links
- Find the code on [gitea](https://git.asonix.dog/asonix/pict-rs)
- Join the discussion on [matrix](https://matrix.to/#/#pictrs:matrix.asonix.dog?via=matrix.asonix.dog)
- Hit me up on [mastodon](https://masto.asonix.dog/@asonix)
2020-06-07 02:01:04 +00:00
## Usage
### Running
```
2022-04-03 18:31:52 +00:00
pict-rs 0.4.0-alpha.1
asonix <asonix@asonix.dog>
A simple image hosting service
2020-06-07 02:01:04 +00:00
USAGE:
pict-rs [OPTIONS] <SUBCOMMAND>
2020-06-07 02:01:04 +00:00
OPTIONS:
-c, --config-file <CONFIG_FILE>
Path to the pict-rs configuration file
2022-04-03 18:31:52 +00:00
--console-address <CONSOLE_ADDRESS>
Address and port to expose tokio-console metrics
2022-04-03 18:31:52 +00:00
--console-buffer-capacity <CONSOLE_BUFFER_CAPACITY>
Capacity of the console-subscriber Event Buffer
-h, --help
Print help information
2021-10-28 05:17:37 +00:00
2022-04-03 18:31:52 +00:00
--log-format <LOG_FORMAT>
Format of logs printed to stdout
2021-09-09 19:18:16 +00:00
2022-04-03 18:31:52 +00:00
--log-targets <LOG_TARGETS>
Log levels to print to stdout, respects RUST_LOG formatting
2022-04-03 18:31:52 +00:00
--old-db-path <OLD_DB_PATH>
Path to the old pict-rs sled database
2022-04-03 18:31:52 +00:00
--opentelemetry-service-name <OPENTELEMETRY_SERVICE_NAME>
Service Name to use for OpenTelemetry
2022-04-03 18:31:52 +00:00
--opentelemetry-targets <OPENTELEMETRY_TARGETS>
Log levels to use for OpenTelemetry, respects RUST_LOG formatting
2022-04-03 18:31:52 +00:00
--opentelemetry-url <OPENTELEMETRY_URL>
URL to send OpenTelemetry metrics
2022-04-03 18:31:52 +00:00
--save-to <SAVE_TO>
File to save the current configuration for reproducible runs
2022-04-03 18:31:52 +00:00
-V, --version
Print version information
2021-09-09 19:18:16 +00:00
2021-10-28 05:17:37 +00:00
SUBCOMMANDS:
2022-04-03 18:31:52 +00:00
filesystem Migrate from the provided filesystem storage
help Print this message or the help of the given subcommand(s)
object-storage Migrate from the provided object storage
run Runs the pict-rs web server
2021-10-28 05:17:37 +00:00
```
2021-10-19 04:44:56 +00:00
2021-10-28 05:17:37 +00:00
```
2022-04-03 18:31:52 +00:00
pict-rs-run
Runs the pict-rs web server
2021-10-28 05:17:37 +00:00
USAGE:
2022-04-03 18:31:52 +00:00
pict-rs run [OPTIONS] [SUBCOMMAND]
2021-10-28 05:17:37 +00:00
OPTIONS:
2022-04-03 18:31:52 +00:00
-a, --address <ADDRESS>
The address and port to bind the pict-rs web server
2020-06-07 02:01:04 +00:00
2022-04-03 18:31:52 +00:00
--api-key <API_KEY>
The API KEY required to access restricted routes
2021-10-28 05:17:37 +00:00
2022-04-03 18:31:52 +00:00
-h, --help
Print help information
2021-10-28 05:17:37 +00:00
2022-04-03 18:31:52 +00:00
--media-enable-silent-video <MEDIA_ENABLE_SILENT_VIDEO>
Whether to enable GIF and silent MP4 uploads. Full videos are unsupported
2021-10-28 05:17:37 +00:00
2022-04-03 18:31:52 +00:00
--media-filters <MEDIA_FILTERS>
Which media filters should be enabled on the `process` endpoint
2022-04-03 18:31:52 +00:00
--media-format <MEDIA_FORMAT>
Enforce uploaded media is transcoded to the provided format
2022-04-03 18:31:52 +00:00
--media-max-area <MEDIA_MAX_AREA>
The maximum area, in pixels, for uploaded media
2022-04-03 18:31:52 +00:00
--media-max-file-size <MEDIA_MAX_FILE_SIZE>
The maximum size, in megabytes, for uploaded media
2022-04-03 18:31:52 +00:00
--media-max-height <MEDIA_MAX_HEIGHT>
The maximum height, in pixels, for uploaded media
2022-04-03 18:31:52 +00:00
--media-max-width <MEDIA_MAX_WIDTH>
The maximum width, in pixels, for uploaded media
2022-04-03 18:31:52 +00:00
--media-skip-validate-imports <MEDIA_SKIP_VALIDATE_IMPORTS>
Whether to validate media on the "import" endpoint
2022-04-03 18:31:52 +00:00
--worker-id <WORKER_ID>
SUBCOMMANDS:
filesystem Run pict-rs with filesystem storage
help Print this message or the help of the given subcommand(s)
object-storage Run pict-rs with object storage
```
Try running `help` commands for more runtime configuration options
```
$ pict-rs run filesystem -h
$ pict-rs run object-storage -h
$ pict-rs run filesystem sled -h
$ pict-rs run object-storage sled -h
2021-10-28 05:17:37 +00:00
```
2022-04-03 18:31:52 +00:00
See [`pict-rs.toml`](https://git.asonix.dog/asonix/pict-rs/src/branch/main/pict-rs.toml) for more
configuration
2021-10-28 05:17:37 +00:00
2020-06-07 02:01:04 +00:00
#### Example:
2022-04-03 23:23:36 +00:00
Run with the default configuration
```
$ ./pict-rs run
```
2020-06-07 02:01:04 +00:00
Running on all interfaces, port 8080, storing data in /opt/data
```
2022-04-03 23:23:36 +00:00
$ ./pict-rs run -a 0.0.0.0:8080 filesystem -p /opt/data/files sled -p /opt/data/sled-repo
2020-06-07 02:01:04 +00:00
```
Running locally, port 9000, storing data in data/, and converting all uploads to PNG
```
2022-04-03 23:23:36 +00:00
$ ./pict-rs run -a 127.0.0.1:9000 --media-format png filesystem -p data/files sled -p data/sled-repo
2020-06-07 02:01:04 +00:00
```
2020-06-07 19:12:19 +00:00
Running locally, port 8080, storing data in data/, and only allowing the `thumbnail` and `identity` filters
```
2022-04-03 23:23:36 +00:00
$ ./pict-rs run -a 127.0.0.1:8080 --media-filters thumbnail --media-filters identity filesystem -p data/files sled -p data/sled-repo
2020-06-07 19:12:19 +00:00
```
2021-10-28 05:17:37 +00:00
Running from a configuration file
```
$ ./pict-rs -c ./pict-rs.toml run
```
2022-04-03 23:23:36 +00:00
Migrating to object storage from filesystem storage
```
2022-04-03 23:23:36 +00:00
$ ./pict-rs filesystem -p data/sled-repo object-storage -a ACCESS_KEY -b BUCKET_NAME -r REGION -s SECRET_KEY
2021-10-28 05:17:37 +00:00
```
2022-04-03 23:23:36 +00:00
Dumping configuration overrides to a toml file
2021-11-01 15:46:14 +00:00
```
2022-04-03 23:23:36 +00:00
$ ./pict-rs --save-to pict-rs.toml run object-storage -a ACCESS_KEY -b pict-rs -r us-east-1 -s SECRET_KEY sled -p data/sled-repo
2021-11-01 15:46:14 +00:00
```
2020-06-07 02:01:04 +00:00
#### Docker
Run the following commands:
```
# Create a folder for the files (anywhere works)
$ mkdir ./pict-rs
$ cd ./pict-rs
$ mkdir -p volumes/pictrs
$ sudo chown -R 991:991 volumes/pictrs
2021-09-08 21:21:47 +00:00
$ wget https://git.asonix.dog/asonix/pict-rs/raw/branch/main/docker/prod/docker-compose.yml
$ sudo docker-compose up -d
```
###### Note
- pict-rs makes use of the system's temporary folder. This is generally `/tmp` on linux
2021-09-01 00:06:09 +00:00
- pict-rs makes use of an imagemagick security policy at
`/usr/lib/ImageMagick-$VERSION/config-Q16HDRI/policy.xml`
#### Docker Development
2021-09-01 00:06:09 +00:00
###### With Arch
```
2022-04-03 23:26:32 +00:00
$ cargo build
2021-09-01 00:06:09 +00:00
$ sudo docker run --rm -it -p 8080:8080 -v "$(pwd):/mnt" archlinux:latest
# pacman -Syu imagemagick ffmepg perl-image-exiftool
2022-04-03 23:23:36 +00:00
# cp /mnt/docker/prod/root/usr/lib/ImageMagick-7.1.0/config-Q16HDRI/policy.xml /usr/lib/ImageMagick-7.1.0/config-Q16HDRI/
2022-04-03 23:26:32 +00:00
# PATH=$PATH:/usr/bin/vendor_perl RUST_LOG=debug /mnt/target/debug/pict-rs run
2021-09-01 00:06:09 +00:00
```
###### With Alpine
```
2022-04-03 23:26:32 +00:00
$ cross build --target=x86_64-unknown-linux-musl
$ sudo docker run --rm -it -p 8080:8080 -v "$(pwd):/mnt alpine:3.15
2021-09-01 00:06:09 +00:00
# apk add imagemagick ffmpeg exiftool
2022-04-03 23:23:36 +00:00
# cp /mnt/docker/prod/root/usr/lib/ImageMagick-7.1.0/config-Q16HDRI/policy.xml /usr/lib/ImageMagick-7.1.0/config-Q16HDRI/
# RUST_LOG=debug /mnt/target/x86_64-unknown-linux-musl/debug/pict-rs RUN
```
2020-06-07 02:01:04 +00:00
### API
2020-07-11 22:27:49 +00:00
pict-rs offers the following endpoints:
2020-06-07 02:01:04 +00:00
- `POST /image` for uploading an image. Uploaded content must be valid multipart/form-data with an
image array located within the `images[]` key
This endpoint returns the following JSON structure on success with a 201 Created status
```json
{
"files": [
{
"delete_token": "JFvFhqJA98",
2022-04-03 23:23:36 +00:00
"file": "lkWZDRvugm.jpg",
"details": {
"width": 800,
"height": 800,
"content_type": "image/jpeg",
"created_at": [
2020,
345,
67376,
394363487
]
}
2020-06-07 02:01:04 +00:00
},
{
"delete_token": "kAYy9nk2WK",
2022-04-03 23:23:36 +00:00
"file": "8qFS0QooAn.jpg",
"details": {
"width": 400,
"height": 400,
"content_type": "image/jpeg",
"created_at": [
2020,
345,
67376,
394363487
]
}
2020-06-07 02:01:04 +00:00
},
{
"delete_token": "OxRpM3sf0Y",
2022-04-03 23:23:36 +00:00
"file": "1hJaYfGE01.jpg",
"details": {
"width": 400,
"height": 400,
"content_type": "image/jpeg",
"created_at": [
2020,
345,
67376,
394363487
]
}
2020-06-07 02:01:04 +00:00
}
],
"msg": "ok"
}
```
- `GET /image/download?url=...` Download an image from a remote server, returning the same JSON
payload as the `POST` endpoint
2022-04-03 23:23:36 +00:00
- `POST /image/backgrounded` Upload an image, like the `/image` endpoint, but don't wait to validate and process it.
This endpoint returns the following JSON structure on success with a 202 Accepted status
```json
{
"uploads": [
{
"upload_id": "c61422e1-9294-4f1f-977f-c696b7939467",
},
{
"upload_id": "62cc707f-725c-44b6-908f-2bd8946c3c29"
}
],
"msg": "ok"
}
```
- `GET /image/backgrounded/claim?upload_id=` Wait for a backgrounded upload to complete, claiming it's result
Possible results:
- 200 Ok (validation and ingest complete):
```json
{
"files": [
{
"delete_token": "OxRpM3sf0Y",
"file": "1hJaYfGE01.jpg"
}
],
"msg": "ok"
}
```
- 422 Unprocessable Entity (validation or otherwise failure):
```json
{
"msg": "Error message about what went wrong with upload"
}
```
- 204 No Content (Upload validation and ingest is not complete, and waiting timed out)
In this case, trying again is fine
2020-06-24 16:58:46 +00:00
- `GET /image/original/{file}` for getting a full-resolution image. `file` here is the `file` key from the
2020-06-07 02:01:04 +00:00
`/image` endpoint's JSON
- `GET /image/details/original/{file}` for getting the details of a full-resolution image.
The returned JSON is structured like so:
```json
{
"width": 800,
"height": 537,
"content_type": "image/webp",
"created_at": [
2020,
345,
67376,
394363487
]
}
```
2020-06-24 16:58:46 +00:00
- `GET /image/process.{ext}?src={file}&...` get a file with transformations applied.
2020-06-07 17:55:42 +00:00
existing transformations include
2020-06-24 16:58:46 +00:00
- `identity=true`: apply no changes
- `blur={float}`: apply a gaussian blur to the file
- `thumbnail={int}`: produce a thumbnail of the image fitting inside an `{int}` by `{int}`
square using raw pixel sampling
- `resize={int}`: produce a thumbnail of the image fitting inside an `{int}` by `{int}` square
using a Lanczos2 filter. This is slower than sampling but looks a bit better in some cases
2020-12-17 00:20:06 +00:00
- `crop={int-w}x{int-h}`: produce a cropped version of the image with an `{int-w}` by `{int-h}`
aspect ratio. The resulting crop will be centered on the image. Either the width or height
of the image will remain full-size, depending on the image's aspect ratio and the requested
aspect ratio. For example, a 1600x900 image cropped with a 1x1 aspect ratio will become 900x900. A
1600x1100 image cropped with a 16x9 aspect ratio will become 1600x900.
2020-06-25 20:39:45 +00:00
2020-06-24 16:58:46 +00:00
Supported `ext` file extensions include `png`, `jpg`, and `webp`
2020-06-25 21:06:33 +00:00
2020-06-07 17:57:36 +00:00
An example of usage could be
```
2020-06-24 16:58:46 +00:00
GET /image/process.jpg?src=asdf.png&thumbnail=256&blur=3.0
2020-06-07 17:57:36 +00:00
```
2020-06-24 16:58:46 +00:00
which would create a 256x256px JPEG thumbnail and blur it
2022-04-03 23:23:36 +00:00
- `GET /image/process_backgrounded.{ext}?src={file}&...` queue transformations to be applied to a given file. This accepts the same arguments as the `process.{ext}` endpoint, but does not wait for the processing to complete.
- `GET /image/details/process.{ext}?src={file}&...` for getting the details of a processed image.
The returned JSON is the same format as listed for the full-resolution details endpoint.
2020-07-11 21:28:49 +00:00
- `DELETE /image/delete/{delete_token}/{file}` or `GET /image/delete/{delete_token}/{file}` to
delete a file, where `delete_token` and `file` are from the `/image` endpoint's JSON
The following endpoints are protected by an API key via the `X-Api-Token` header, and are disabled
2022-04-07 02:40:49 +00:00
unless the `--api-key` option is passed to the binary or the PICTRS__SERVER__API_KEY environment variable is
set.
A secure API key can be generated by any password generator.
2022-04-04 00:26:42 +00:00
- `POST /internal/import` for uploading an image while preserving the filename as the first alias.
The upload format and response format are the same as the `POST /image` endpoint.
- `POST /internal/purge?alias={alias} Purge a file by it's alias. This removes all aliases and
files associated with the query.
2020-07-11 22:26:41 +00:00
This endpoint returns the following JSON
```json
{
"msg": "ok",
"aliases": ["asdf.png"]
}
```
2022-04-04 00:26:42 +00:00
- `GET /internal/aliases?alias={alias} Get the aliases for a file by it's alias
- `?alias={alias}` get aliases by alias
2020-07-11 22:26:41 +00:00
This endpiont returns the same JSON as the purge endpoint
2020-07-11 21:28:49 +00:00
2021-09-11 20:31:00 +00:00
Additionally, all endpoints support setting deadlines, after which the request will cease
processing. To enable deadlines for your requests, you can set the `X-Request-Deadline` header to an
i128 value representing the number of nanoseconds since the UNIX Epoch. A simple way to calculate
this value is to use the `time` crate's `OffsetDateTime::unix_timestamp_nanos` method. For example,
```rust
// set deadline of 1ms
let deadline = time::OffsetDateTime::now_utc() + time::Duration::new(0, 1_000);
let request = client
.get("http://pict-rs:8080/image/details/original/asdfghjkla.png")
.insert_header(("X-Request-Deadline", deadline.unix_timestamp_nanos().to_string())))
.send()
.await;
```
2020-06-07 02:01:04 +00:00
## Contributing
Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the AGPLv3.
## FAQ
### Question: I want to configure it with yaml instead of toml
Answer: That's not a question, but you can configure pict-rs with json, hjson, yaml, ini, or toml.
Writing configs in other formats is left as an exercise to the reader.
2020-06-07 02:01:04 +00:00
## License
2022-03-22 20:10:48 +00:00
Copyright © 2022 Riley Trautman
2020-06-07 02:01:04 +00:00
pict-rs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
pict-rs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of pict-rs.
You should have received a copy of the GNU General Public License along with pict-rs. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).