Describe Docker image usage in README

This commit is contained in:
timvisee 2019-03-13 18:56:04 +01:00
parent 5de3f89de7
commit fad390f584
No known key found for this signature in database
GPG key ID: B8DB720BC383E172
2 changed files with 24 additions and 1 deletions

View file

@ -280,10 +280,32 @@ move .\ffsend.exe C:\Windows\System32\ffsend.exe
```
### Other OS or architecture
If your system runs Docker, you can use the [docker image](#docker-image).
There are currently no other binaries or packages available.
You can [build the project from source](#build) instead.
#### Docker image
A Docker image is available for using `ffsend` running in a container.
Mount a directory to `/data`, so it's accessible for `ffsend` in the container,
and use the command as you normally would.
`timvisee/ffsend`][docker-hub-ffsend]
```bash
# Run container with no parameters
docker run --rm -it -v $PWD:/data timvisee/ffsend
# Upload a file
docker run --rm -it -v $PWD:/data timvisee/ffsend upload my-file.txt
# Download a file
docker run --rm -it -v $PWD:/data timvisee/ffsend download https://send.firefox.com/#sample-share-url
# View help
docker run --rm -it -v $PWD:/data timvisee/ffsend help
```
## Build
To build and install `ffsend` yourself, you meet the following requirements
before proceeding:
@ -537,3 +559,4 @@ Check out the [LICENSE](LICENSE) file for more information.
[snapcraft-ffsend]: https://snapcraft.io/ffsend
[homebrew]: https://brew.sh/
[wsl]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
[docker-hub-ffsend]: https://hub.docker.com/r/timvisee/ffsend

View file

@ -3,5 +3,5 @@ LABEL maintainer="Tim Visée <tim@visee.me>"
COPY ./ffsend /
WORKDIR /
WORKDIR /data/
ENTRYPOINT ["/ffsend"]