Rustic

Rustic is a personal media server made for two reasons:

to get familiar with Rust.
to get familiar with writing server applications.
to deal with Flameshot custom image uploads.
- note: flameshot custom uploader application can be found here.
- note: ShareX compatibility is not a goal in mind as of writing this.

Usage in Production

This is absolutely by no-means a production-ready project. There are many other similar projects which are much more mature and stable. Please use those instead.

Details

This project is written in Rust using the Rocket web framework. Rustic can be built the same way any other Cargo project can, via. cargo build. You can specify the --release option to apply many different optimizations. The project can be run with cargo run, however this is unnecessary if using a pre-built release.

First Iteration

The first iteration of this project is just a generic media server. It accepts multipart/form-data uploads, with each entry being limited to 10MB. This limit is unconfigurable as of version 0.3.0. When uploading images, the file name is returned (without the extension as of 0.3.0). This name can be used to fetch the media source you uploaded.

Media will never expire unless manually deleted, and all media is assigned a unique random base64-encoded ID. This ID is an unsigned 128-bit integer, and the maximum bound can be configured with the RUSTIC_MAX_FILE_ID environment variable, which defaults to 64^8. Media is stored in a directory specified by the optional environment variable RUSTIC_MEDIA_DIRECTORY, which defaults to media/.

All environment variables are processed lazily. A RUSTIC_API_AUTHORIZATION environment variable must be present for any authorization-requiring request to be performed.

Note: As of 0.3.0, when specifying a custom media directory, the name must end with a /.

Routes

<base path> refers to the path specified at configuration by the RUSTIC_API_BASE_PATH environment variable, however this does default to /api/v1 if the variable isn't present.

POST `<base path>/media` -- `multipart/form-data`

This requires authorization.
Uploads media to Rustic. The ID of the newly-uploaded file is returned as a string with 200 OK.
If this operation fails, 500 Internal Serve4r Error is returned along with a description of the error.

DELETE `<base path>/media/<id>`

This requires authorization.
Deletes the file associated with the ID if present. On success, 204 No Content is returned, otherwise 404 Not Found is.
If the operation fails (i.e because of a lack of permissions on the server side), 500 Internal Server Error is returned, again, with a description of the error.

GET `<base path>/media/<id>`

Fetches the file associated with the ID if present with 200 OK.

Rocket Configuration

Rocket allows you to configure many aspects of the web server. The defaults are almost always good enough, but if you want to fine-tune things go ahead and modify the Rocket.toml file included in this repository and then restart Rustic.

By default, Rocket will search the working directory first and then every subsequent parent until it reaches root. For faster start-up times, try to keep the file in the working directory instead of elsewhere, although the difference will be negligible.

SamOphis/rustic