LemmyNet
/
pict-rs
mirror of https://git.asonix.dog/asonix/pict-rs
2
0
Fork 0
Code Releases Activity

Remove redundant default info, update readme help, add 'check' helper

This commit is contained in:
asonix 2020-06-25 18:17:05 -05:00
parent 83ebf4d872
commit cc37f0dd8a
5 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -4,7 +4,7 @@ _a simple image hosting service_
## Usage ## Usage
### Running ### Running
``` ```
pict-rs 0.1.4 pict-rs 0.2.0-alpha.2
USAGE: USAGE:
pict-rs [FLAGS] [OPTIONS] --path <path> pict-rs [FLAGS] [OPTIONS] --path <path>
@ -15,10 +15,10 @@ FLAGS:
-V, --version Prints version information -V, --version Prints version information
OPTIONS: OPTIONS:
-a, --addr <addr> The address and port the server binds to. Default: 0.0.0.0:8080 [env: -a, --addr <addr> The address and port the server binds to. [env: PICTRS_ADDR=] [default:
PICTRS_ADDR=] [default: 0.0.0.0:8080] 0.0.0.0:8080]
-f, --format <format> An optional image format to convert all uploaded files into, supports 'jpg' -f, --format <format> An optional image format to convert all uploaded files into, supports 'jpg',
and 'png' [env: PICTRS_FORMAT=] 'png', and 'webp' [env: PICTRS_FORMAT=]
-m, --max-file-size <max-file-size> Specify the maximum allowed uploaded file size (in Megabytes) [env: -m, --max-file-size <max-file-size> Specify the maximum allowed uploaded file size (in Megabytes) [env:
PICTRS_MAX_FILE_SIZE=] [default: 40] PICTRS_MAX_FILE_SIZE=] [default: 40]
-p, --path <path> The path to the data directory, e.g. data/ [env: PICTRS_PATH=] -p, --path <path> The path to the data directory, e.g. data/ [env: PICTRS_PATH=]
@ -59,8 +59,9 @@ dependencies already present
$ git clone https://git.asonix.dog/asonix/pict-rs $ git clone https://git.asonix.dog/asonix/pict-rs
$ cd pict-rs/docker/dev $ cd pict-rs/docker/dev
$ ./dev.sh $ ./dev.sh
$ build $ check # runs cargo check
$ run -- -p data/ $ build # runs cargo build
$ run -p data/
``` ```
Development environments are provided for amd64, arm32v7, and arm64v8. By default `dev.sh` will load Development environments are provided for amd64, arm32v7, and arm64v8. By default `dev.sh` will load
into the contianer targetting amd64, but arch arguments can be passed to change the target. into the contianer targetting amd64, but arch arguments can be passed to change the target.
@ -70,7 +71,7 @@ $ build
# note: # note:
# This command may not work unless qemu-user-static has been configured for your docker instance # This command may not work unless qemu-user-static has been configured for your docker instance
$ run -- -p data/ $ run -p data/
``` ```
### API ### API

3
docker/dev/root/usr/bin/build
View File

@ -1,4 +1,5 @@
#!/usr/bin/env bash #!/usr/bin/env bash
shift set -xe
cargo build --target=$TARGET cargo build --target=$TARGET

5
docker/dev/root/usr/bin/check Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -xe
cargo check --target=$TARGET

3
docker/dev/root/usr/bin/run
View File

@ -1,4 +1,5 @@
#!/usr/bin/env bash #!/usr/bin/env bash
shift set -xe
cargo run --target=$TARGET -- "$@" cargo run --target=$TARGET -- "$@"

2
src/config.rs
View File

@ -14,7 +14,7 @@ pub(crate) struct Config {
long, long,
env = "PICTRS_ADDR", env = "PICTRS_ADDR",
default_value = "0.0.0.0:8080", default_value = "0.0.0.0:8080",
help = "The address and port the server binds to. Default: 0.0.0.0:8080" help = "The address and port the server binds to."
)] )]
addr: SocketAddr, addr: SocketAddr,