Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
hannesdejager committed Sep 27, 2019
1 parent 776fe78 commit d341fc3
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,29 @@ make docker-run
Partly as an example, there is also 'minimal' image available that is statically linked and build `FROM scratch`. To use it use `make docker-minimal` and `make docker-run-minimal`.
For the full list of supplied docker images, use `make docker-list`.

## Running

To run with default settings:

```sh
cargo run
```

To show a list of program arguments:

```sh
cargo run -- \
--help
```

Example running an instance with a filesystem back-end and custom port

```sh
cargo run -- \
--fs-home-dir=/home/unftp/data \
--bind-address=0.0.0.0:2100
```

## License

You're free to use, modify and distribute this software under the terms of the Apache-2.0 license.

0 comments on commit d341fc3

Please sign in to comment.