mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-11-25 00:18:17 +01:00
Remove Docker details from readme
This information should be placed in the documentation page.
This commit is contained in:
parent
0dd8bf5074
commit
8ff0ebddf3
1 changed files with 0 additions and 65 deletions
65
README.md
65
README.md
|
@ -21,71 +21,6 @@ in the documentation, that can be found here: [gitbook.io](https://openbrewing.g
|
||||||
Plugins extend the base functionality of CraftBeerPi 4.
|
Plugins extend the base functionality of CraftBeerPi 4.
|
||||||
You can find a list of available plugins [here](https://openbrewing.gitbook.io/craftbeerpi4_support/master/plugin-installation#plugin-list).
|
You can find a list of available plugins [here](https://openbrewing.gitbook.io/craftbeerpi4_support/master/plugin-installation#plugin-list).
|
||||||
|
|
||||||
### Docker image
|
|
||||||
While CraftbeerPi is primarily created to be run on a RaspberryPi
|
|
||||||
you can also use a docker image to run it. This let's you try CraftBeerPi
|
|
||||||
quickly without much installation overhead. It can also be very handy
|
|
||||||
when developing your own plugins.
|
|
||||||
|
|
||||||
Images are currently available for `arm64` and `amd64` architectures.
|
|
||||||
That means, that they won't run on a RaspberryPi unless you installed
|
|
||||||
a 64bit version of the OS. This is only a requirement for the docker image,
|
|
||||||
not if you install CraftBeerPi on the pi directly.
|
|
||||||
|
|
||||||
### Start a container
|
|
||||||
You can also use the image in your real setup with docker or docker-compose (or other orchestrators).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# setup the configuration directory for later use in a volume mount (must be done once)
|
|
||||||
mkdir config && chown :1000 config
|
|
||||||
docker run --rm -v "$(pwd)/config:/cbpi/config" ghcr.io/avollkopf/craftbeerpi4:latest cbpi setup
|
|
||||||
|
|
||||||
# run craftbeerpi
|
|
||||||
docker run -d -v "$(pwd)/config:/cbpi/config" -p 8000:8000 ghcr.io/avollkopf/craftbeerpi4:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
or as compose file
|
|
||||||
```yml
|
|
||||||
version: "3.7"
|
|
||||||
services:
|
|
||||||
craftbeerpi:
|
|
||||||
image: ghcr.io/avollkopf/craftbeerpi4:latest
|
|
||||||
volumes:
|
|
||||||
- "./config:/cbpi/config"
|
|
||||||
ports:
|
|
||||||
- 8000:8000
|
|
||||||
```
|
|
||||||
|
|
||||||
Please note that this setup does not include GPIO functionality for CraftBeerPi 4.
|
|
||||||
You may be lucky with one of the methods described here to get it to work:
|
|
||||||
https://stackoverflow.com/questions/30059784/docker-access-to-raspberry-pi-gpio-pins
|
|
||||||
|
|
||||||
#### Install plugins in the container
|
|
||||||
You can create your own image based on `ghcr.io/avollkopf/craftbeerpi4` and install
|
|
||||||
plugins as `RUN` commands in the docker file as you would in a regular environment.
|
|
||||||
|
|
||||||
Sample `Dockerfile`
|
|
||||||
```Dockerfile
|
|
||||||
FROM ghcr.io/avollkopf/craftbeerpi4:vXX.XX.XX.XX
|
|
||||||
|
|
||||||
# Switch to root user for installing plugins
|
|
||||||
USER root
|
|
||||||
|
|
||||||
# Install plugins
|
|
||||||
RUN pip3 install --no-cache-dir cbpi4-pt100x
|
|
||||||
|
|
||||||
# Don't forget to switch back to craftbeerpi user
|
|
||||||
USER craftbeerpi
|
|
||||||
|
|
||||||
# Add plugin to craftbeerpi
|
|
||||||
RUN cbpi add cbpi4-pt100x
|
|
||||||
```
|
|
||||||
Then build the image
|
|
||||||
```bash
|
|
||||||
docker build . -t yourimagename
|
|
||||||
```
|
|
||||||
Then build and use your image in the `docker run` command or `docker-compose` file.
|
|
||||||
|
|
||||||
## 🧑🤝🧑 Contributers
|
## 🧑🤝🧑 Contributers
|
||||||
Thanks to all the people who have contributed
|
Thanks to all the people who have contributed
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue