Merge branch 'siph-readme-nix-instructions'

This commit is contained in:
Jack Wills
2022-10-17 18:42:04 +00:00
+18 -8
View File
@@ -14,20 +14,30 @@
</a> </a>
</p> </p>
## Run via Docker
Published on <a href='https://hub.docker.com/r/mrjackwills/oxker' target='_blank' rel='noopener noreferrer'>Docker Hub</a>, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6`
`docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker`
## Download & install ## Download & install
### Cargo
Published on <a href='https://www.crates.io/crates/oxker' target='_blank' rel='noopener noreferrer'>crates.io</a>, so if you have cargo installed, simply run Published on <a href='https://www.crates.io/crates/oxker' target='_blank' rel='noopener noreferrer'>crates.io</a>, so if you have cargo installed, simply run
```cargo install oxker``` ```cargo install oxker```
else see the <a href="https://github.com/mrjackwills/oxker/releases/latest" target='_blank' rel='noopener noreferrer'>pre-built binaries</a> ### Docker
Published on <a href='https://hub.docker.com/r/mrjackwills/oxker' target='_blank' rel='noopener noreferrer'>Docker Hub</a>, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6`
`docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker`
### Nix
Using nix flakes, oxker can be ran directly with
```nix run nixpkgs#oxker```
Without flakes, you can build a shell that contains oxker using
```nix-shell -p oxker```
### Pre-Built
See the <a href="https://github.com/mrjackwills/oxker/releases/latest" target='_blank' rel='noopener noreferrer'>pre-built binaries</a>
or, download & install (x86_64 one liner) or, download & install (x86_64 one liner)
@@ -110,4 +120,4 @@ or individually
```docker run --name postgres -e POSTGRES_PASSWORD=never_use_this_password_in_production -d postgres:alpine3.16``` ```docker run --name postgres -e POSTGRES_PASSWORD=never_use_this_password_in_production -d postgres:alpine3.16```
```docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3``` ```docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3```