1. Get the binary either from the [releases page](https://github.com/raftario/filite/releases) or [using Cargo](https://crates.io/crates/filite)
2. Run it a first time and follow the instructions
3. Edit your config file, check the [dedicated section](#Config) for details
4. Run the binary again and you're good to go, just browse to http://localhost:8080 (don't forget to replace `8080` with the port specified in your config)
5. Optionally, set up a [reverse proxy](#Reverse proxy)
## Usage
When asked for a login, use whatever username you want and the password you provided during setup. Usage is pretty straightforward using the web UI, but here are some tips.
* Make sure to allow popups to allow created links to open in a new tab
* Press space in the URL input to generate a random one
* If the entered URL is already in use, the input will have a yellow outline
Details for programmatic usage are provided in [the dedicated section](#Programmatic usage).
## Planned features
* Decent test suite
* TLS support
* Opt-in stats (visits per element over time)
* Opt-in syntax highlighting for text
* Multiple users and passwords
* Simple admin page
* systemd service generation
## Config
The config is located at `~/.filite/config.toml` and follows the following format. Most of the time, the defaults are reasonable.
```toml
# Port to listen on
port = 8080
# SQLite database URL
database_url = "database.db"
# Database connection pool size
pool_size = 4
# Path to the directory where files will be stored, relative or absolute
files_dir = "files"
# Max allowed size for file uploads, in bytes
max_filesize = 10000000
```
## Reverse proxy
### NGINX
Don't forget to replace `8080` with the port specified in your config and `example.com` with your own domain.
Send a PUT request with a JSON body following the following schemes. Don't forget to set the `Content-Type` header to `application/json` and the `Authorization` header to a valid value (username isn't important).
#### File
`PUT /f/id`
```json
{
"base64": "Base64-encoded file",
"filename": "Filename"
}
```
#### Link
`PUT /l/id`
```json
{
"forward": "URL to forward to"
}
```
#### Text
`PUT /t/id`
```json
{
"contents": "Text contents"
}
```
### Getting existing elements
The response will be a JSON array following the following schemes
#### Files
`GET /f`
```json
[
{
"id": "ID (URL) as an integer",
"filepath": "Absolute path to the stored file",
"created": "Creation timestamp"
}
]
```
#### Links
`GET /l`
```json
[
{
"id": "ID (URL) as an integer",
"forward": "URL to forward to",
"created": "Creation timestamp"
}
]
```
#### Texts
`GET /t`
```json
[
{
"id": "ID (URL) as an integer",
"contents": "Text contents",
"created": "Creation timestamp"
}
]
```
## Contributing
The project is open to contributions! Before submitting a PR, make sure your changes work both with and without the `dev` feature enabled.
### Requirements
* The Rust toolchain
* [diesel_cli](https://github.com/diesel-rs/diesel/tree/master/diesel_cli) with the `sqlite` feature enabled
### Setup
1. Copy [`.env.example`](./.env.example) to `.env` and set the variables to your liking
2. Run `diesel database setup`
3. Build or run with the `dev` feature enabled
## License
filite is licensed under the [MIT License](./LICENSE).
