From 6bc5c28649cd97b087c06b17d9fb465061c1ab10 Mon Sep 17 00:00:00 2001 From: buanet Date: Thu, 25 Nov 2021 20:49:26 +0100 Subject: [PATCH 01/10] testing --- debian/node12/Dockerfile | 97 +++++++++++++++++++++++++++++++++ src/README_docker_hub_buanet.md | 13 ++++- 2 files changed, 107 insertions(+), 3 deletions(-) create mode 100644 debian/node12/Dockerfile diff --git a/debian/node12/Dockerfile b/debian/node12/Dockerfile new file mode 100644 index 0000000..fe2edfd --- /dev/null +++ b/debian/node12/Dockerfile @@ -0,0 +1,97 @@ +FROM debian:bullseye-slim + +LABEL org.opencontainers.image.title="Official ioBroker Docker Image" \ + org.opencontainers.image.description="Officical Docker image for ioBroker smarthome software (https://www.iobroker.net)" \ + org.opencontainers.image.documentation="https://github.com/buanet/ioBroker.docker#readme" \ + org.opencontainers.image.authors="André Germann " \ + org.opencontainers.image.url="https://github.com/buanet/ioBroker.docker" \ + org.opencontainers.image.source="https://github.com/buanet/ioBroker.docker" \ + org.opencontainers.image.base.name="docker.io/library/debian:bullseye-slim" \ + org.opencontainers.image.version="${VERSION}" \ + org.opencontainers.image.created="${DATI}" + +ENV DEBIAN_FRONTEND noninteractive + +# Install prerequisites (including node) and generating locales +RUN apt-get update && apt-get install -y \ + apt-utils \ + cifs-utils \ + curl \ + gosu \ + iputils-ping \ + jq \ + locales \ + nfs-common \ + procps \ + python3 \ + python3-dev \ + sudo \ + tar \ + tzdata \ + udev \ + wget \ + # Install node + && curl -sL https://deb.nodesource.com/setup_12.x | bash \ + && apt-get update && apt-get install -y nodejs \ + # Install node-gyp + && npm install -g node-gyp \ + # Generating locales + && sed -i 's/^# *\(de_DE.UTF-8\)/\1/' /etc/locale.gen \ + && sed -i 's/^# *\(en_US.UTF-8\)/\1/' /etc/locale.gen \ + && locale-gen + +# Create directorys and copy scripts +COPY scripts /opt/scripts +COPY userscripts /opt/userscripts +RUN chmod 777 /opt/scripts/ \ + && chmod 777 /opt/userscripts/ \ + && chmod +x /opt/scripts/*.sh \ + && chmod +x /opt/userscripts/*.sh + +# Install ioBroker +RUN curl -sL https://iobroker.net/install.sh | bash - \ + && mkdir -p /opt/scripts/.docker_config/ \ + && echo "starting" > /opt/scripts/.docker_config/.healthcheck \ + && echo "${VERSION}" > /opt/scripts/.docker_config/.thisisdocker \ + && echo $(hostname) > /opt/.firstrun \ + # Deleting UUID from build + && iobroker unsetup -y \ + # Backup initial ioBroker and userscript folder + && tar -cf /opt/initial_iobroker.tar /opt/iobroker \ + && tar -cf /opt/initial_userscripts.tar /opt/userscripts \ + # Setting up iobroker-user (shell, home dir and rights) + && chsh -s /bin/bash iobroker \ + && usermod --home /opt/iobroker iobroker \ + && usermod -u 1000 iobroker \ + && groupmod -g 1000 iobroker \ + && chown root:iobroker /usr/sbin/gosu \ + && chmod +s /usr/sbin/gosu \ + # Clean up installation cache + && apt-get autoclean -y \ + && apt-get autoremove \ + && apt-get clean \ + && rm -rf /tmp/* /var/tmp/* \ + && rm -rf /root/.cache/* /root/.npm/* \ + && rm -rf /var/lib/apt/lists/* + +# Setting up default ENVs +ENV DEBIAN_FRONTEND="teletype" \ + LANG="de_DE.UTF-8" \ + LANGUAGE="de_DE:de" \ + LC_ALL="de_DE.UTF-8" \ + SETGID=1000 \ + SETUID=1000 \ + TZ="Europe/Berlin" + +# Expose default admin ui port +EXPOSE 8081 + +# Change work dir +WORKDIR /opt/iobroker/ + +# Healthcheck +HEALTHCHECK --interval=15s --timeout=5s --retries=5 \ + CMD ["/bin/bash", "-c", "/opt/scripts/healthcheck.sh"] + +# Run startup-script +ENTRYPOINT ["/bin/bash", "-c", "/opt/scripts/iobroker_startup.sh"] diff --git a/src/README_docker_hub_buanet.md b/src/README_docker_hub_buanet.md index 7f86964..b44219d 100644 --- a/src/README_docker_hub_buanet.md +++ b/src/README_docker_hub_buanet.md @@ -10,7 +10,9 @@ [![License](https://img.shields.io/github/license/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/blob/master/LICENSE.md) [![Donate](https://img.shields.io/badge/donate-paypal-blue?style=flat)](https://paypal.me/buanet) -**Note:** New major versions (e.g. v4, v5, v6) of the image always come with a new major verson of node (preinstalled). To avoid issues when upgrading into a new major version the best practice recommendation is to migrate using backup and restore procedure. For more details please see "Best Practices" section on official [readme.md](https://github.com/buanet/ioBroker.docker#best-practices). +# Important Note + +New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at the brand new [Official ioBroker Docker Image Docs](https://docs.buanet.de/iobroker-docker-image/docs/). # Quick reference @@ -20,11 +22,16 @@ * Supported architectures: amd64, arm32v7, arm64v8 * Changelog: [Github Repository Changelog](https://github.com/buanet/ioBroker.docker/blob/main/CHANGELOG.md) * Source code: [Github Repository](https://github.com/buanet/ioBroker.docker) -* All other questions should be answered here: [Github Repository Readme](https://github.com/buanet/ioBroker.docker#readme) or [iobroker.net](https://www.iobroker.net/) +* All other questions should be answered here: [Official ioBroker Docker Image Docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/) # Supported tags -* [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile) +It is highly recommended not to use the `latest` tag for production, especially when using any kind of automated update procedure like watchtower. Please use the `latest-vX` tag instead. + +### Node 14 versions +* [`v6.0.0`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest-v6`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile) +### Node 12 versions +* [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile) * [`v5.1.0`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/armv7hf/Dockerfile), [`v5.1.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/aarch64/Dockerfile) * [`v5.0.0`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/amd64/Dockerfile), [`v5.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/amd64/Dockerfile), [`v5.0.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/armv7hf/Dockerfile), [`v5.0.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/aarch64/Dockerfile) From 5d59a618a2d6b261b57360a0e343b8186dea80c6 Mon Sep 17 00:00:00 2001 From: buanet Date: Mon, 6 Dec 2021 20:53:51 +0100 Subject: [PATCH 02/10] docu --- CHANGELOG.md | 11 +- README.md | 184 ++++++-------------------------- src/README_docker_hub_buanet.md | 3 +- 3 files changed, 38 insertions(+), 160 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3bdf299..d7179c3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,13 @@ ## Changelog ### v6.0.0-beta1 (2021-10-07) -* upgrading node version to recommended v14 -* adding beta-node16 tag for betatest +* upgrading node version to recommended node14 +* adding beta-node16 tag for beta testing node16 +* updating documentation * v5.3.0-beta1 (2021-10-07) - * adding check for PACKAGES on startup (#201) - * adding packages for discovery - * adding packages for backitup + * adding check (installed) PACKAGES on startup (#201) + * adding packages for discovery adapter + * adding packages for backitup adapter * reorganizing Dockerfile ### v5.2.0 (2021-09-30) diff --git a/README.md b/README.md index 3e936e4..11a7e32 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,40 @@ [![License](https://img.shields.io/github/license/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/blob/master/LICENSE.md) [![Donate](https://img.shields.io/badge/donate-paypal-blue?style=flat)](https://paypal.me/buanet) -This image is a ready to use Docker image for ioBroker IoT platform (http://www.iobroker.net). +The code provided in this repo is used to automatically generate the official Docker Image for ioBroker. -It was originally created for running on a Synology DiskStation 1515+ with DSM 6 and official Docker package installed, but should run on any other Linux based Docker host too. +If you don't know what ioBroker is, please check out [iobroker.net](https://www.iobroker.net) -After years of development it might be the best documented and maintained Docker image for running ioBroker IoT platform with Docker. +If you dont know what Docker is, please check out [docker.com](https://docker.com) -Since v4.0.0 the image is available for the following architectures: amd64, armv7hf, aarch64. +## Getting started -In v5.1.0 it became the official Docker Image for the ioBroker Project. +### Basic Information + +You will find some basic information about the image amd how to use it on the [Docker Hub page](https://hub.docker.com/r/buanet/iobroker) or [here](https://github.com/buanet/ioBroker.docker/blob/main/src/README_docker_hub_buanet.md). + +### Detailed documentation + +You will find a detailed documentation of the image at the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/). + +### Get the image + +You can pull the Docker image from: +* [Docker Hub (buanet)](https://hub.docker.com/r/buanet/iobroker) +* [Docker Hub (iobroker)](https://hub.docker.com/r/iobroker/iobroker) +* [GitHub Container Repo](https://github.com/buanet/ioBroker.docker/pkgs/container/iobroker) + +### Get help + +If you have any questions or need help please contact the ioBroker community: +* [ioBroker Forum]() +* [Discord Channel]() +* [Facebook Group]() +* [Telegram Group]() + +### Report an issue or request a feature + +If you found an issue or missing some feature please let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). ## Important notice @@ -30,157 +55,8 @@ You might avoid these procedure if you use my "Best practice" hint for "upgradin In any case make a backup first! -## Getting started - -A detailed tutorial (German, based on v3.0.0) can be found here: [https://smarthome.buanet.de](https://smarthome.buanet.de/2019/05/iobroker-unter-docker-auf-der-synology-diskstation-v3/). Please notice that the old tutorial is outdated and does no longer work! - -For discussion and support please visit [ioBroker forum thread](http://forum.iobroker.net/viewtopic.php?f=17&t=5089) or use the comments section at the linked tutorial. - -Please do not contact me directly for any support-reasons. Every support question should be answered in a public place so every user can benefit from it . Thanks in advance. - -If you think you found a bug or simply want to request a new feature please open an issue on Github so we can talk about. - -The following ways to get iobroker-container running are only examples. Maybe you have to change, add or replace parameters to configure ioBroker for fitting your needs. - -### Running from command line - -For taking a first look at the iobroker docker container it would be enough to simply run the following basic docker run command: - -``` -docker run -p 8081:8081 --name iobroker -v iobrokerdata:/opt/iobroker buanet/iobroker:latest -``` - -### Running with docker-compose - -You can also run iobroker by using docker-compose. Here is an example: - -``` -version: '2' - -services: - iobroker: - restart: always - image: buanet/iobroker:latest - container_name: iobroker - hostname: iobroker - ports: - - "8081:8081" - volumes: - - iobrokerdata:/opt/iobroker -``` - -## Special settings and features - -The following will give a short overview. - -### Environment variables - -To configure the ioBroker container on startup it is possible to set some environment variables. -You do not have to declare every single variable when setting up your container. Variables you do not set will come up with their default value. - -**Important: In v4.2.0 the ENVs "ADMINPORT" and "REDIS" were renamed/ reorganized. For Details see the following table!** - -|ENV|Default|Description| -|---|---|---| -|AVAHI|false|Installs and activates avahi-daemon for supporting yahka-adapter, can be "true" or "false"| -|IOB_ADMINPORT|8081|Sets ioBroker adminport on startup| -|IOB_MULTIHOST|[not set]|Sets ioBroker instance as "master" or "slave" for multihost support (needs additional config for objectsdb and statesdb!)| -|IOB_OBJECTSDB_HOST|127.0.0.1|Sets host for ioBroker objects db| -|IOB_OBJECTSDB_PORT|9001|Sets port for ioBroker objects db| -|IOB_OBJECTSDB_TYPE|file|Sets type of ioBroker objects db, cloud be "file" or "redis"
(at the moment redis as objects db is [not officially supported by ioBroker](https://github.com/ioBroker/ioBroker#databases))| -|IOB_STATESDB_HOST|127.0.0.1|Sets host for ioBroker states db| -|IOB_STATESDB_PORT|9000|Sets port for ioBroker states db| -|IOB_STATESDB_TYPE|file|Sets type of ioBroker states db, could be "file" or "redis"| -|LANG|de_DE.UTF‑8|The following locales are pre-generated: de_DE.UTF-8, en_US.UTF-8| -|LANGUAGE|de_DE:de|The following locales are pre-generated: de_DE:de, en_US:en| -|LC_ALL|de_DE.UTF-8|The following locales are pre-generated: de_DE.UTF-8, en_US.UTF-8| -|PACKAGES|[not set]|Installs additional linux packages to your container, packages should be seperated by whitespace like this: "package1 package2 package3"| -|SETGID|1000|For some reasons it might be useful to specify the gid of the containers iobroker user to match an existing group on the docker host| -|SETUID|1000|For some reasons it might be useful to specify the uid of the containers iobroker user to match an existing user on the docker host| -|TZ|Europe/Berlin|All valid Linux-timezones| -|USBDEVICES|none|Sets relevant permissions on mounted devices like "/dev/ttyACM0", for more than one device separate with ";" like this: "/dev/ttyACM0;/dev/ttyACM1"| -|ZWAVE|false|Will install openzwave to support zwave-adapter, can be "true" or "false"| - -### Mounting folder/ volume - -It is possible to mount an empty folder to /opt/iobroker during first startup of the container. The startup script will check this folder and restore content if it is empty. - -Since v4.1.0 it is also possible mount a folder filled up with an iobroker backup file created using `iobroker backup` command or backitup adapter. Please make sure the name of your backup file ends like this: `*_backupiobroker.tar.gz"`. - -The startup script will then detect this backup and restore it during the start of the container. Please see container logs when starting the container for more details! - -Note: It is absolutely recommended to use a mounted folder or persistent volume for /opt/iobroker folder! - -You can also mount a folder containing an existing ioBroker-installation (e.g. when moving an existing installation to docker). -But watch for the used node version. If the existing installation runs with another major version of node you have do perform additional steps. For more Details see the "Important notice" on top of this readme.md file. - -**Important: If the folder you mount to /opt/iobroker in your container is placed on a mounted device, partition or other storage, the mountpoint on your host should NOT have the "noexec" flag activated. Otherwise you may get problems executing ioBroker inside the container!** - -### Mounting USB device - -If you want to use a USB device within ioBroker inside your container don´t forget to [mount the device](https://docs.docker.com/engine/reference/commandline/run/#add-host-device-to-container---device) on container startup and use the environment variable "USBDEVICES". - -### User defined startup scripts - -It is possible to add some script code to container startup with the help of the userscripts feature. You can get this to work by mounting an additional folder to `/opt/userscripts` into the container. - -When you mount an empty folder the startup script will restore two example scripts in there. To activate the scripts you have to remove the `_example` part of the name. The "userscript_firststart.sh" will execute only at the very first start of a new container, while the "userscript_everystart.sh" will execute on every container start. - -Feel free to test it with my example code. Take a look at the log. In "Step 4 of 5: Applying special settings" you will see the messages generated by the example userscripts. - -### Multihost - -With the help of the ENV "IOB_MULTIHOST" and the ENVs for objects and states db connections (see ENVs table above) it is now possible to run a container as standalone, multihost master or multihost slave. This is more or less a feature for advanced users. Please make sure you know how ioBroker multihost is working and set the ENVs as with `ìobroker setup custom`. - -There is no need for executing `iobroker multihost enable` or `iobroker multihost connect` inside the container. Just configure the mentioned ENVs. The startup script will do all the magic. - -For general information about iobroker multihost feature please see [official ioBroker documentation](https://www.iobroker.net/docu/index-24.htm?page_id=3068&lang=de). - -### Healthcheck - -Since v5.1.0 the image contains a simple Docker healthcheck. At the moment it only checks if js-controller is running inside the container and reports "healthy" or "unhealthy" to the Docker daemon. Further development is planned. - -The healthcheck is configured to 5 retries in an 15s interval with a timeout of 5s. So a container needs a minimum of one minute to get unhealthy. - -Hint: As the Docker daemon itself gives no opportunity to automatically restart an unhealthy container you might want to setup some kind of "watchdog container" like this simple one: https://github.com/buanet/docker-watchdog. - -### Maintenance script (beta) - -Within the implementation of the docker health check (above) some manual maintenance actions, like stopping ioBroker for upgrading js-controller, would cause the container to get "unhealthy" and may cause an external watchdog to automatically restart it. - -In this case you can use the new maintenance command line tool inside the container. By simply typing `maintenance on` it will activate some kind of "maintenance mode" and automatically stop ioBroker while the container stays healthy. - -After your maintenance is done just type `maintenance off`. Depending on the selected restart policy of your container, the command will stop (and automatically restart) it. - -## Best practices - -### Avoid using "latest" docker tag - -To avoid conflicts when upgrading your container or getting in trouble when accidentally upgrading your container to a new major version I prefer using a version docker tag like "v4.2.0" instead of "latest" for creating your container. - -With v5.1.0 an additional docker tag "latest-[major version]" is available. This gives you the possibility update your container automatically while always staying in the same major version. - -### Upgrading your container - -If you want to upgrade your ioBroker container to a new major version (e.g. from v4 to v5) I would prefer to do that by creating a backup in ioBroker (by "iobroker backup" or backitup adapter) and restoring it to a completely new container. All you need is time an the following steps: -* make a backup by command line ("iobroker backup") or backitup adapter -* stop the old container -* create a new and empty data folder or volume and place your backup file in it -* create a new container as your old or as you need it and use the new data folder/ volume for the /opt/iobroker mount point -* follow the log output of the container and be patient - -After this steps the startup script inside the container will automatically detect and restore your backup to a new ioBroker instance. When iobroker is started after the restore it will install your adapters to the new ioBroker instance by itself. This might take some time but will give you the best and cleanest results... - -### Switching states db from file to redis - -If you want to switch states db from file to redis on a n existing installation you might want to keep all your actual states. As simply setting the needed ENVs won't migrate your existing states into the redis db it is best practice to first run "iobroker setup custom" inside your container before adding the ENVs. This will give you the choice to migrate your states. - ## Miscellaneous -### Detecting this Docker image by ioBroker (feature for adapter developers) - -For adapter developers it is now possible to easily detect if ioBroker is running inside the official docker container. Please simply check if the file `/opt/scripts/.docker_config/.thisisdocker` exists. The content of the file will tell the image version. - ### Beta testing If you want to get the newest features and changes feel free to use/ test the beta version of the Docker image. You can find the readme.md file for beta versions [here](https://github.com/buanet/ioBroker.docker/blob/beta/README.md). Please make sure to read the changelog before testing beta versions. diff --git a/src/README_docker_hub_buanet.md b/src/README_docker_hub_buanet.md index b44219d..2381e77 100644 --- a/src/README_docker_hub_buanet.md +++ b/src/README_docker_hub_buanet.md @@ -3,7 +3,7 @@ [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/buanet/iobroker/latest?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Pulls](https://img.shields.io/docker/pulls/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Stars](https://img.shields.io/docker/stars/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/buanet/ioBroker.docker/Build%20debian%20based%20image%20\(beta\))](https://github.com/buanet/docker.watchdog/actions/workflows/docker_build_main_image.yml) +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/buanet/ioBroker.docker/Build%20debian%20based%20image%20\(latest\))](https://github.com/buanet/ioBroker.docker/actions/workflows/build-debian-image-main.yml) [![Release](https://img.shields.io/github/v/release/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/releases) [![Github Issues](https://img.shields.io/github/issues/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/issues)
[![Source](https://img.shields.io/badge/source-github-blue?style=flat)](https://github.com/buanet/ioBroker.docker) @@ -30,6 +30,7 @@ It is highly recommended not to use the `latest` tag for production, especially ### Node 14 versions * [`v6.0.0`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest-v6`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile) + ### Node 12 versions * [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile) * [`v5.1.0`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/armv7hf/Dockerfile), [`v5.1.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/aarch64/Dockerfile) From a0460749c29d703321c4c075ad6b2fc8fa9c2811 Mon Sep 17 00:00:00 2001 From: buanet Date: Mon, 6 Dec 2021 22:30:40 +0100 Subject: [PATCH 03/10] docs --- README.md | 41 +++++++++++++++---------------- src/README_docker_hub_buanet.md | 4 +-- src/README_docker_hub_iobroker.md | 20 ++++++++++----- 3 files changed, 36 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 11a7e32..7684a0c 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,42 @@ -[![Source](https://img.shields.io/badge/source-github-blue?style=flat)](https://github.com/buanet/ioBroker.docker) -[![Release](https://img.shields.io/github/v/release/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/releases) -[![Github Issues](https://img.shields.io/github/issues/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/issues)
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/buanet/iobroker/latest?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Pulls](https://img.shields.io/docker/pulls/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Stars](https://img.shields.io/docker/stars/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/buanet/ioBroker.docker/Build%20debian%20based%20image%20\(latest\))](https://github.com/buanet/ioBroker.docker/actions/workflows/build-debian-image-main.yml) +[![Release](https://img.shields.io/github/v/release/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/releases) +[![Github Issues](https://img.shields.io/github/issues/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/issues)
+[![Source](https://img.shields.io/badge/source-github-blue?style=flat)](https://github.com/buanet/ioBroker.docker) [![License](https://img.shields.io/github/license/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/blob/master/LICENSE.md) [![Donate](https://img.shields.io/badge/donate-paypal-blue?style=flat)](https://paypal.me/buanet) The code provided in this repo is used to automatically generate the official Docker Image for ioBroker. -If you don't know what ioBroker is, please check out [iobroker.net](https://www.iobroker.net) +## Quick links -If you dont know what Docker is, please check out [docker.com](https://docker.com) +Don't know what's ioBroker? :arrow_right: [iobroker.net](https://www.iobroker.net)
+Don't know what's Docker? :arrow_right: [docker.com](https://docker.com)
+Looking for documentation? :arrow_right: [docs.buanet.de](https://docs.buanet.de/iobroker-docker-image/docs/) -## Getting started +## FAQ (frequently asked questions) -### Basic Information +### How to run the image? -You will find some basic information about the image amd how to use it on the [Docker Hub page](https://hub.docker.com/r/buanet/iobroker) or [here](https://github.com/buanet/ioBroker.docker/blob/main/src/README_docker_hub_buanet.md). +You con find some basic information about the image amd how to run it on the [Docker Hub page](https://hub.docker.com/r/buanet/iobroker) or [here](https://github.com/buanet/ioBroker.docker/blob/main/src/README_docker_hub_buanet.md). -### Detailed documentation +### Is there a more detailed documentation? -You will find a detailed documentation of the image at the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/). +You con find a detailed documentation of the image on the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/). -### Get the image +### Where can I pull the image? You can pull the Docker image from: * [Docker Hub (buanet)](https://hub.docker.com/r/buanet/iobroker) * [Docker Hub (iobroker)](https://hub.docker.com/r/iobroker/iobroker) * [GitHub Container Repo](https://github.com/buanet/ioBroker.docker/pkgs/container/iobroker) -### Get help +### Where can I get help? If you have any questions or need help please contact the ioBroker community: * [ioBroker Forum]() @@ -42,18 +45,14 @@ If you have any questions or need help please contact the ioBroker community: * [Facebook Group]() * [Telegram Group]() -### Report an issue or request a feature +### How to report an issue or request a feature? -If you found an issue or missing some feature please let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). +If you think you found an issue let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). Make sure you have googled it before. +Please do not use the issues for support questions. Not every error message is worth a new report. Use [discussions](https://github.com/buanet/ioBroker.docker/discussions) if you are not sure. -## Important notice +### Is there something else I have to know? -In general a new major version (e.g. v2, v4, v5) of the image comes with a new, preinstalled major node version! -If you are updating an existing installation to a new major version (e.g. from v4 to v5) you have to perform some additional steps inside ioBroker! For more details please see official ioBroker documentation: [EN](https://www.iobroker.net/#en/documentation/install/updatenode.md) | [DE](https://www.iobroker.net/#de/documentation/install/updatenode.md).
- -You might avoid these procedure if you use my "Best practice" hint for "upgrading your ioBroker container". - -In any case make a backup first! +Always have an actual valid backup of your ioBroker. You can easily create a backup by using the `iobroker backup` command or the preinstalled backitup adapter. ## Miscellaneous diff --git a/src/README_docker_hub_buanet.md b/src/README_docker_hub_buanet.md index 2381e77..d0888f3 100644 --- a/src/README_docker_hub_buanet.md +++ b/src/README_docker_hub_buanet.md @@ -12,7 +12,7 @@ # Important Note -New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at the brand new [Official ioBroker Docker Image Docs](https://docs.buanet.de/iobroker-docker-image/docs/). +New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at our new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/). # Quick reference @@ -22,7 +22,7 @@ New major image versions (e.g. v4, v5, v6) always come with a new major version * Supported architectures: amd64, arm32v7, arm64v8 * Changelog: [Github Repository Changelog](https://github.com/buanet/ioBroker.docker/blob/main/CHANGELOG.md) * Source code: [Github Repository](https://github.com/buanet/ioBroker.docker) -* All other questions should be answered here: [Official ioBroker Docker Image Docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/) +* All other questions should be answered here: [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/) # Supported tags diff --git a/src/README_docker_hub_iobroker.md b/src/README_docker_hub_iobroker.md index 626a7fc..bb33d55 100644 --- a/src/README_docker_hub_iobroker.md +++ b/src/README_docker_hub_iobroker.md @@ -3,13 +3,15 @@ [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/buanet/iobroker/latest?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Pulls](https://img.shields.io/docker/pulls/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Stars](https://img.shields.io/docker/stars/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/buanet/ioBroker.docker/Build%20debian%20based%20image%20\(beta\))](https://github.com/buanet/docker.watchdog/actions/workflows/docker_build_main_image.yml) +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/buanet/ioBroker.docker/Build%20debian%20based%20image%20\(latest\))](https://github.com/buanet/ioBroker.docker/actions/workflows/build-debian-image-main.yml) [![Release](https://img.shields.io/github/v/release/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/releases) [![Github Issues](https://img.shields.io/github/issues/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/issues)
[![Source](https://img.shields.io/badge/source-github-blue?style=flat)](https://github.com/buanet/ioBroker.docker) [![License](https://img.shields.io/github/license/buanet/ioBroker.docker?style=flat)](https://github.com/buanet/ioBroker.docker/blob/master/LICENSE.md) -**Note:** New major versions (e.g. v4, v5, v6) of the image always come with a new major verson of node (preinstalled). To avoid issues when upgrading into a new major version the best practice recommendation is to migrate using backup and restore procedure. For more details please see "Best Practices" section on official [readme.md](https://github.com/buanet/ioBroker.docker#best-practices). +# Important Note + +New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at our new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/). # Quick reference @@ -19,11 +21,17 @@ * Supported architectures: amd64, arm32v7, arm64v8 * Changelog: [Github Repository Changelog](https://github.com/buanet/ioBroker.docker/blob/main/CHANGELOG.md) * Source code: [Github Repository](https://github.com/buanet/ioBroker.docker) -* All other questions should be answered here: [Github Repository Readme](https://github.com/buanet/ioBroker.docker#readme) or [iobroker.net](https://www.iobroker.net/) +* All other questions should be answered here: [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/) # Supported tags -* [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile) +It is highly recommended not to use the `latest` tag for production, especially when using any kind of automated update procedure like watchtower. Please use the `latest-vX` tag instead. + +### Node 14 versions +* [`v6.0.0`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest-v6`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile) + +### Node 12 versions +* [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile) * [`v5.1.0`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/armv7hf/Dockerfile), [`v5.1.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/aarch64/Dockerfile) * [`v5.0.0`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/amd64/Dockerfile), [`v5.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/amd64/Dockerfile), [`v5.0.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/armv7hf/Dockerfile), [`v5.0.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/aarch64/Dockerfile) @@ -40,7 +48,7 @@ For further details please check out [iobroker.net](https://www.iobroker.net). For taking a first look at iobroker on docker it would be enough to simply run the following basic docker run command: ``` -docker run -p 8081:8081 --name iobroker -h iobroker iobroker/iobroker +docker run -p 8081:8081 --name iobroker -h iobroker buanet/iobroker ``` ## Running with docker-compose @@ -53,7 +61,7 @@ version: '2' services: iobroker: container_name: iobroker - image: iobroker/iobroker + image: buanet/iobroker hostname: iobroker restart: always ports: From 9dd5391499bbf4131f94c8aec3bf44a05e0bda5d Mon Sep 17 00:00:00 2001 From: buanet Date: Mon, 6 Dec 2021 22:35:35 +0100 Subject: [PATCH 04/10] docu --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7684a0c..34c9a6b 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ The code provided in this repo is used to automatically generate the official Docker Image for ioBroker. -## Quick links +## :rocket: Quick links Don't know what's ioBroker? :arrow_right: [iobroker.net](https://www.iobroker.net)
Don't know what's Docker? :arrow_right: [docker.com](https://docker.com)
Looking for documentation? :arrow_right: [docs.buanet.de](https://docs.buanet.de/iobroker-docker-image/docs/) -## FAQ (frequently asked questions) +## :question: FAQ (frequently asked questions) ### How to run the image? @@ -54,7 +54,7 @@ Please do not use the issues for support questions. Not every error message is w Always have an actual valid backup of your ioBroker. You can easily create a backup by using the `iobroker backup` command or the preinstalled backitup adapter. -## Miscellaneous +## :memo: Miscellaneous ### Beta testing From 868a129397e3357346f08a9608e94e527cf4e857 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Germann?= Date: Mon, 6 Dec 2021 23:11:23 +0100 Subject: [PATCH 05/10] Add files via upload --- src/img/pp_logo.png | Bin 0 -> 11776 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 src/img/pp_logo.png diff --git a/src/img/pp_logo.png b/src/img/pp_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..c57646551bae658ed3e65d6ea6c21fde0bff1e38 GIT binary patch literal 11776 zcmXv!2Rzj8|Ig>nUEH}+wkwg;Nk$P;anV9X2xVs{TvSHJCo64DLY$(gj6xK-i-v?G zWyUGrWW-hWxcfh!^ZR?fym;38dGGan&RJRPrI6%E004@~zFpP;;NZVFAWVdR#=}}? z;UA$8BNJO;_!BAYnFPlojD3ef;Qlu37cruxhrvnN6T2Nw*aUf>2z3wk0->Ry>VAR# zAs+4wFZG~cpY+k~asa4Bne5tW8`k;zn;*K$>$VODw|x1{<16=gQMTpLXm^u@H=HN0 zsZSalNfvv0VzS9%G9JYK$`ht-IG;3rEo%MgeMTz`Pue;iw>s`F;}`~Yp{Mr=(@O$Ozon$5 zzc4r%K9td#-Y6{rj224yu3ZNI$$YnxzjA-H!%kFv-zrZY6ExrIi}4;xNz^KRUrrdd zwhx&5`J1jKLO@N0_|f_AyAqS#MFYk0w-qkwD-`) z5HbP%D$G~1nW7dZtFkQ3_pS2347Xk58XoCV*kq;1vdfLQ&uertMwlvnG2CYpYw;4_ zi#MJ08S?O6NdlFsKudIg(pO7sX&=>>KUa}}28EwVTq|KT*;*6WaqCLQS)9WB6|)_F znnu~4y0epie2++=N2JliwPK{&FhQKw@Ao2H z(UNRJ>C^D&6;?pF5@Z~;LcIRchgNwP;OMCY=5Hfz)ym=#xYriPD%2nI_Jj zKR1B*gTPzXf==+9lAF*8l>{{^fTf#?lG5BJH-OTp>D9h?;EUG{f5gPmyQI+1qHCC! z_J8=A+<1h5K2rhC6h$UQ&GKdEb~}(4iB!A=xX$*G)@bjiIJy^^y|Q+RFuT0blYrJs zp>q^@1u^^d4}%2UH!p+tX#rcN%;N=wB(+Oq8lX|Cnpw zZJ`Qo6agpyW^g8A^MriKVT8Gz;FhU~7aGZKz525ZM<13(4P`ayoUdVfATx#&`NN`8 z3hS%g0#!k&3!+zRg#?$%GO9ZYK(ju9c{Ur@Uss!7+ZaSZUuu9hDvjRM{W}^6Mr4Y( z!r8*jwUS`65X^TdAi)ua?01dF3Fxf^K1+5Dy(w!MBQLxVG|%H0_YqvbQ{3X9`7;-+ z;fiQEBg}9D=L2zx*qJ%&qRnlRAk77gZq`HhUDRD1@Q(U|tL>@!Z;#o7_K<1TD>hi8 z)fR~jkZIH%+4W1yy9&o1CDViAa7oRpZI-0{gZixwT({7`6_Gs%%>{8dx({59Sa&k% zP!TBphvUX13W+_@NSlCKzl0Q#)0AW4>86J9oz{tG~cX}Yd{51iA>o7F& zvl_>~K;RJL5L(ic#ev)NY#{NvHoq-xfdnoQIEuyyEjinph2t#yck5A)uM8mkD{nRIgGZtWlUaBbPoiHX zvkfV5z{}{gmx61ed}C3-@jbG|i3G}W6`p=0AG^VSM zL6FvfSjj2kE8QLt>qQ6(KXKeu(p%XUjme8EFR>M# z%6bXZp*AKf=g&ln`U&*T>5?i4bR*dNyaG8jyfQo+ymkOhp~vwfb{dO=#7b->VsTJC z{GHfd@cb{l`3ab>dqXL9oO(|tC_Ll#>Q3CaKy@qE$#qfIl|WNT>`m&&&~@SI-4Ol; zkag++Ui@LywTF`q6LE%1*D=xi-eqFl`8&J?o>POLa zhiKa%$|Uw5bzgLyqtfEQ$Eg{ZPlj|r2-cvGu@kS|vD))2PRtCMK0}sczL&qXibUT? z;KT^_JsyEL2=nc8GLOTZA9$O0A$6w_y-x|E&Bub06-o3SGJChWC+h9L9y;49Y4iy; z__v2nP?#ccETlKnOI{vKq=9e^z+x!kwY#2R5JINMQX-l#7-!!vCn$U*a0=9qoEpx_ z&+VT+m)l=)Jhwkp)%5+Rd!{CpeYyR0*}45ma_!GYB1@@X!|X20b%X_8mj4!(czIQN zX1+*n|LgbREQ6)Dlt}bUGW(6u<&>@NM}DvkA{i>-AtxVd-1wNiK>c{wPVVVb#z^Y8 zs6~Bk*4WDMd4UzR$3Cmr10Q_|VL-DSk z41Yf`o~U!LNu0kCJF-4;__t$B|uyl3nDl;sW$Q8I0A{6tdkTPe{J2Tm!uPZqS96wHdhT3B37T`NOg z(^V-YB*9xB8-1ylWU>|DFngVz|7(YMt6=8lBo@Q;$IYt5i^rBIuA&;HOkA6BT` zNOM&d@u?3fi+-p(dxeIn|W z)|UtoM@F-aeClDWEh4xj7GE6yQ=Q3OQlNTT_S1(LDZM?nAVbsuOFXrDc1hYF&sRTA zP3v&zhah&F=3Vb}Zq!to9}luJzFkg8^y(#US6sv`l++;X<-eb(ZOarA?Z`NB+nY>B z>b#I&8#O%~=hBbSjB_(i>{hv5m3?D8b;0;H1Xlo@l(m(vf6MXIH1^8)lVBbE-xaxo z8uRAX2Tvy-gR->--Xe{4VZWByHW7Lwo&e88^_Vq-R#O%;@N_nqck$h`_VnfF*`hZ; zpKiKLP|!MMe#(`uA$t$RujDPc|4g_kY2}W3dgA#V%Ed2k?04b+#U;Pzy?pn$%kvUW z>?opV?z`tF_f_I%+d#bAKp)@w3whN1;ZaxB5DB!IMAyxhy?Xt=PBr_rTVj3KaQhBv zbbsU1cP%Rzsoe*F(FWiuma%DpXV^neG>za(r`v&NJu53l{*(%>Tyt6iwIZ>dUdetQ z`Ss^4YRoc(fY`ONQ8*e;~8Jt|;zb z?I#lUa=SI?ybGK*XnREP_!4;84TJq6r|rS!xRmYvpI(vZjuPmwkk78mB?yo_Ihit9 z4LpfzyvhL~8n~$r{t+Hf05d_oy5J;ZUn~o=ak9VaH10u`Q9|!;)yj ze<3OF*AbX2`eKrs;dH50rD6ehFVVik6TD|4O671fTs>@I%xyuU{2?SD@yK)Qvk% zZzG_=lIZT(&qUCSdnc+9G#%9D@ihRZJ2VipJVOVdQhNVh)Jvf6hs{g|{Ju$m!&>vM z8rn)BsT7cx8hG-i3b?)Lk*@NpAqy+uTY%$6XZyiqtdER7wfuQ=1L%^Mehiuq6F9+w z`7`2s?RDnMD?NXvNP@%nz3-^jL} zZ3sxmB@gb1iNmpbq)?VfQ>qR~l&iNAIZN@avlrvsNV^{hohU3=s}BUWt-K~fJfUgi-$v(AsvCp z^g|3W?axn?YJ~Z}XB+tWIC=<~ZT$+P?!IOBN;{-3PsK@Zy)S_t zg{C3CPPRd8t~MquScCpjZ=*hOlmB;WWJ`?&n1PK0^ZA zRKaSgv`x2<;z9k3xhxmgdv-q`0PSiejyD0lBZ=~iFwNMt-uY?~_v1x}CkGHW9|C6` zv_T@<0WViSc-QeCv;*e{SFFHv8?M-tv8O-pDpC8!hwKHj_c_92u9eDuuBTBPdy;Fo%eNDNw6K4@$!})Vz$HU`D-9ge0IQd$JqZ9ZtyWTF zsi|Y!kK@iM(sJ5oPeFtQBE~yQZfw^9M47M6oiAG7 z90Z&1$f?_c^UlCv9VW!e;|<*D8pDv8Ze9;5cHI zR80PT^t&j(;RYo)=i%ff68$)ty<>4fI(l0VuDN1q*lnCuH;!9@DcQ*D<#9ij^7mgk z)N2pU%kuV;8tYa)u`=~_drO=?@Ai?IRc?LoB?bc#U6!`IkfFVJ&S4L@NC?n{g17f3t+^M(R-62`AQJaoh44dlc?;v|W_sV1hk^>eHi%>5J-^-5o33RU+X ziQeWHCxODk*dyUS1t?7P6_NOFeGn%I>K=$Z3^fU@@z>3Pp-E$2>zmKFyV(526&cI7 z_7FkozJYB7{;8D4OvpI6-4&{<3>7pV8_QTT?mG1M`3Ff1be1r*W-EuiOVyQsw2>B4 zhP3$WN%Z+X{`uBDm_CsPlZUKZ{GYM;_5$rrVu1{SbX|rm@W(P1EKv)5aEy4?)|L` zKFHf(Kn%q*mizhO!Q`(}Rld)OvhzJ=^t29ND zDnYjjrZE*Y$!G6CO;eHe`>*IwMAPj@;I%V|RupJcU~}z<=&7-R11z;q9+S%?(Xd+n z&HMov%a)cSVB14=<=?;O%Ik8qf~>)JH4r2TuU0rZ@QqgIICM?cUIqM-LN8$QOZqx! zPyX}r)5%#YfT>-pPE7FH5kxCP z4Wl~^N5@t56_uTM98-i7^O+vYig01PEk!ijxewZx{|vzlm|~6O0k@r~Kuf|Gn+xmF5;?hoo-AZj$H; zEno*O*dzQyNK!f2FAjyJFlBLj?c)!B*D%8$K`xNlL70Nqm4!O19j%@^y=*$Cm@9RGQ;=6Uzq z!j6neC-G5pbzo1zqTX9F;e6lY;e-(7){RlSFfiU zk)#rE0z;5pve1!lG7}+^jDrakql|O0?zj#}`dtvcVETR_Q2cd(*X#OA&l_}*-W;5! zBQz&pD%jPZv@P<=qP$jlBYG|&jDg-~BH zlH1?nXQaD!L8|8grWVzhSEHwIi*QhpePPQ%b#Y;MNNe~Z_-s{b#Y_vPyqA}>z4j@HGMcL_H-u;Ve}OV z9!YAb(%FC@6e01Hcp`RAgI%}jd3aoQh`-r6CxyGdlu zSql9S4^7VZi{--V>1(>v;R{8$DYX!Eh9G_RE zM7(*8%u>?!*vu(ha`*jKch(0SS6V=jmHRHQ)j!gA)W%$sp5FDK>*6^Qy}OS;hDoRN zS19lE=YKj8H<=edRg|S)pDbG<@I_N(bI8|?K~#HFqS}gUn}(r-J>YeR-Rp-`IAJb) z-PTiKDuV{jdQv+F5-&sFOW>$tZeWB*WWCDmzdJ^Hb5{l$=&z?1oUu}{5ldCwQgo;9 z%x#&Q-~BnHX*+=_L*VShNIS)V7{TDLqI)g~zLxO|u_cM;k2zBfHD ziw8=|XJ5N|8sC~%s;?5C)ldaKSRrSt0qUw2lR+6 zq)4J(7%_z7^L5rOyic*snsKJ;;^;l3A}CVQ?50IlC%#0?d&z&ofRG% za~5Z%rVX8X>RO=-VbXk+!QPiYR!vTJbPe!gECez91+?rZ9)u$YjQFd>%}l;5i#I6n zX#T#0d{uC~*hrAr)oil+op|F~sD+Ah7R&k9=h+wghhZcw0^2bUDaNsxdHU{8^+1|+ z@SlL({__WM=QkTnh7KB%u7}6+6Sy%Y(7)1!T?eOBmDgX~pzP!9YO3F+V{pz~^MH!; zgJpJD!qNm|=Issp{+%f2IljGhZCOm&jqwZ>)OQ<9cUs+x2uM$g56VP3R?l`k=pGUOjV2J+NW96J=%Dfqa)3lR zh_v;UI)PW1`=(#1V*bl`le0nSA@>qXr2Q};iZtF00JbUDJ{PGgd)QG?E8BbaJ5p@F z$itJBAku~*<%{R!$<6(wPc~Ki0AhiX>C5cG;HQl^zR_uadgj)friOGdjuxZ@8Z38S)|SW zUD9=;K#Pm+QL+o%-`OV51T=66$y+YSO1qzc$nW0xWnl+W{Jzwo{% z)daCZL~>$r9zZ<`5M6?DNCWvh6sRt*K5=CRG3 z_5b-BxgueHi0^uBrEZ{i@~Qihs=SC-MMBj$ZV`cV-AL;x1syr~Ovzp*jC~<=!TwA2 zPL3+z9|nmcO?5ip>A)N{f<3u}cj6(xqSzjsvIBvF6#Alya@2qa4zm!Z#j>jA1wkS&%sJHZ6&SQz_?}eqgl~1zIv`~ zRqVAVYem}f@HuHw11LVecV8hGf$dH)s3*h2#MNP~V?l&UT=NYacL%(~GOCRmw}uK` z8Y~&yUKIlETrlsz*pm|yhY0W9;x|0TlNLTnfDcQopdmkaU??F`LE;luVswp*;G7X( z*n6>ny%!S9T=#wRiMB~q1&t~|n$(z7_2aOy*!jGHjIFUw2&`>oApid&aGze(PyW6n zRiLH<%E?VhPTU=}V&`-CclqX>ZKJBMCDB_j7banq?NUr<<#bSxUNim$mL- zS&?KZ>|{x!8?t4uhDLv4Bowp$vP{_Us>L5^7&3=lD{-NRII$zstCKs|>M3nzJjo^p1pI|z z_;k+;tURuD+_favkNXdmu!80;^(Cr z8>G$*N!-qHxYE%@@yHwhJP(^L5~(D*JeeH@DM)G3 zPR?HOw&>fn@zjY0*a3;Iu}11V7SrNAp2=8~C7K+Q4js?VeH*YI_SlNFtG5|f`b7WR z%q?WCy+hR}?oltw~ef@hnsE<7(YS&xnVii_Rlb5?AzN) zP@r6F%fTA1qAo|0j6=+!U|alqj)qRyhLRBF_N-pK>N#Rc$adP*%(x6UlH?_P*(@gIGdW3v#B6D446UHxp?+lpqCnDc&^ zjNx6%@GfW#}@Rf-;H#Rf1Xuy%wo2koXs1zIsGxmrq<`$go>lMvI|WC+Ka;C2pb_!~osobcArS1)^fm%tV`nH>i$Z^wY} z=lO*mzFFTgI9JOzjK|8S4}_zIH8Fif35GNfZ~!z(!HUzjgv-CgT|!_Mkm#$SADxQc zo%iz%S}89Ezv3wMLMnE`t37l;ushVeObi@!S^vQ+vRF11KXLyV|HZ(YL?eXZs)crkqS-KgV>b5`|dy1M0&)Q*` zC~OEch(A*tG8lFwuA>3P1im{IyV5Zrl<%=1E0~f*|6$2n^;;r6sjy-$ymkflKErl{ z9M=i}LVhsyrbcs=% z=5^y1F)7C)OZX#5T2c5T%Hl@sjYa<}xl2{V67pvJF5QazF=KXV{*?$hW9KWSZ6x`bH|)DaUBT6ERqlXcwf*V8Yp*diTSC zx~_r%3qkT{6IV&H9bF4R!o6UeNoR42HGb~qVFSc*1#47 zx|#YU_}(ix;Y)CfhqrX-lDfnuT*vpuEf;9o7pwyI>IDwRGzF+s9Dri{pe+#N7orjk zWFmA~T_7b8Vw0AP0JjFojODT(c!g#PxslB2C87k)* zV5?O(QL=S_8(oP(B-nx6+e8EHMc_U6@ z1)>>Mne_;Uii4RIYtv!){hj$64 zU27P4t>fRMr~vkFt#D1_Ic%M>?I-&!_&RswETkXpS_u^RQzNk$n+vWN4DUFjWm}1U4KDTy4#2)YF z)CFW&@b|ivr@20Oo7>ae&oYK-3aMK`7rd2;$G)Tyt=h6>(-yU|=q}@k|Xt(?6SbA>+z+YRd&aor%S2m`o@kCz*h)!T5=bjbFZzE_teZLYkN|1bXZF%Z9Q zAzdbx3FtFR4?Rc>C3OReGcW$12npO6OFo%yV8kKjMf3$_SXu#Q=5gu>^6$11ms-S;xX@A?)}E`A~zM z2pSBnRFPra4IH?ti+hpbtvqNT2gfo{sAP&hKAhILRP?_>2VL-xf<17MAuYH0HUgl%XI?~(9uZh@K+}3AaKkghsNm(D#ob4n zzq81gQeKA4!YIv4^SUC^&Axc3^Qz z{Fb9%LX31ZzxhP9{cj6VotKVnVLm9q_%cPGNGsp-i|7eEpYS7))c;MwF3NDMu0riC z!$BvEGDE97RD<0)r|S^YIp}@ywgnEY3a|E%h{# zGpeZwa55NB9}t5N;*V~!)8mhKJ?3Gdi$R1uc(%9|VQ&+bfhYgzWs!X(s&}Cj%jY z>|3b#HH@btU!A5LE0tmC^QB3e3B)GP_`6mHO-9cayi#UQHF1=e`Sd>4vxhLMt0}+A zxuLOD1gK;B3#~CxcK0)s>4*YLS9mg`L_zk+k$a5ZZxOw-BjS8x?7NIRRJdAL+n(PS zTPoUMhUL(rhv%m};oFGgYCp#uW>!`9A7umBaV(qQGpDL1OxgzTU3=KswoQrdKg-Yg W(dEfoo0<#YkI8O}U4=$&vHu4&=5&An literal 0 HcmV?d00001 From da63f43852748b27a9e7c44e10814e0c8870b055 Mon Sep 17 00:00:00 2001 From: buanet Date: Mon, 6 Dec 2021 23:21:52 +0100 Subject: [PATCH 06/10] docu --- README.md | 36 ++++++++++++++---------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 34c9a6b..8a697c0 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ The code provided in this repo is used to automatically generate the official Docker Image for ioBroker. +Because this README has become more and more confusing, I decided to convert it into a full documentation and moved it to a ["better place"](https://docs.buanet.de/iobroker-docker-image/docs/). + ## :rocket: Quick links Don't know what's ioBroker? :arrow_right: [iobroker.net](https://www.iobroker.net)
@@ -24,11 +26,11 @@ Looking for documentation? :arrow_right: [docs.buanet.de](https://docs.buanet.de ### How to run the image? -You con find some basic information about the image amd how to run it on the [Docker Hub page](https://hub.docker.com/r/buanet/iobroker) or [here](https://github.com/buanet/ioBroker.docker/blob/main/src/README_docker_hub_buanet.md). +You can find some basic information about the image amd how to run it on the [Docker Hub page](https://hub.docker.com/r/buanet/iobroker) or [here](https://github.com/buanet/ioBroker.docker/blob/main/src/README_docker_hub_buanet.md). ### Is there a more detailed documentation? -You con find a detailed documentation of the image on the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/). +You can find a detailed documentation of the image on the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/). ### Where can I pull the image? @@ -40,43 +42,33 @@ You can pull the Docker image from: ### Where can I get help? If you have any questions or need help please contact the ioBroker community: -* [ioBroker Forum]() -* [Discord Channel]() -* [Facebook Group]() -* [Telegram Group]() +* [ioBroker forum](https://forum.iobroker.net/) +* [Discord channel](https://discord.gg/Ne3y6fUac3) +* [Facebook group](https://www.facebook.com/groups/440499112958264/) ### How to report an issue or request a feature? If you think you found an issue let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). Make sure you have googled it before. Please do not use the issues for support questions. Not every error message is worth a new report. Use [discussions](https://github.com/buanet/ioBroker.docker/discussions) if you are not sure. -### Is there something else I have to know? - -Always have an actual valid backup of your ioBroker. You can easily create a backup by using the `iobroker backup` command or the preinstalled backitup adapter. - -## :memo: Miscellaneous +## :eyes: Miscellaneous ### Beta testing -If you want to get the newest features and changes feel free to use/ test the beta version of the Docker image. You can find the readme.md file for beta versions [here](https://github.com/buanet/ioBroker.docker/blob/beta/README.md). Please make sure to read the changelog before testing beta versions. - -### Subscribe to updates - -If you want the newest updates about the image and my tutorials at https://smarthome.buanet.de you can simply subscribe to my new "news and updates" channel (only in German) on Telegram. -You will find the channel here: https://t.me/buanet_tutorials +If you want to get the newest features and changes feel free to use/ test the beta version of the Docker image. You can find the changelog for beta versions [here](https://github.com/buanet/ioBroker.docker/blob/dev/CHANGELOG.md). For more details and beta support join us at the "docker-image" chat on the [ioBroker Discord channel](https://discord.gg/Ne3y6fUac3). ### Support the project The easiest way to support this project is to leave me some likes/ stars on Github and Docker hub!
-If you want to give something back, feel free to take a look into the [open issues](https://github.com/buanet/ioBroker.docker/issues) or the [ioBroker forum thread](http://forum.iobroker.net/viewtopic.php?f=17&t=5089) and helping me answering questions, fixing bugs or adding new features!
-And if you want to buy me a beer instead, you can do this here:
+If you want to give something back to the community, feel free to take a look into the [open issues](https://github.com/buanet/ioBroker.docker/issues) or the [ioBroker forum thread](http://forum.iobroker.net/viewtopic.php?f=17&t=5089) and help me answering questions, fixing bugs or adding new features!
+If that doesn't work for you and you want to buy me a beer instead, you can do this here:
Thank you! -## Changelog +## :memo: Changelog Moved to [CHANGELOG.md](CHANGELOG.md). -## License +## :copyright: License MIT License @@ -100,6 +92,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## Credits +## :star: Credits Inspired by https://github.com/MehrCurry/docker-iobroker From a8f90cab494685aa97ce67a04708109bd59cdb2d Mon Sep 17 00:00:00 2001 From: buanet Date: Thu, 9 Dec 2021 20:44:07 +0100 Subject: [PATCH 07/10] update readme --- README.md | 4 ++-- src/README_docker_hub_buanet.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8a697c0..b5f82d8 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,14 @@ You can pull the Docker image from: ### Where can I get help? -If you have any questions or need help please contact the ioBroker community: +If you have any questions or need help please visit the ioBroker community: * [ioBroker forum](https://forum.iobroker.net/) * [Discord channel](https://discord.gg/Ne3y6fUac3) * [Facebook group](https://www.facebook.com/groups/440499112958264/) ### How to report an issue or request a feature? -If you think you found an issue let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). Make sure you have googled it before. +If you think you found an issue let us know by opening a [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). Make sure you have googled it before. Please do not use the issues for support questions. Not every error message is worth a new report. Use [discussions](https://github.com/buanet/ioBroker.docker/discussions) if you are not sure. ## :eyes: Miscellaneous diff --git a/src/README_docker_hub_buanet.md b/src/README_docker_hub_buanet.md index d0888f3..97c8d2f 100644 --- a/src/README_docker_hub_buanet.md +++ b/src/README_docker_hub_buanet.md @@ -12,7 +12,7 @@ # Important Note -New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at our new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/). +New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see the maintenance part of the new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/#maintenance). # Quick reference From 859aaf1526db3f31f9878dadee783a2755f7f2b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Germann?= Date: Thu, 9 Dec 2021 22:46:50 +0100 Subject: [PATCH 08/10] Update .VERSION --- .VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.VERSION b/.VERSION index 274570d..9773998 100644 --- a/.VERSION +++ b/.VERSION @@ -1 +1 @@ -v6.0.0-beta \ No newline at end of file +v6.0.0 From 28402a09c472a9105430d60b8296e0a6db90ad9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Germann?= Date: Thu, 9 Dec 2021 22:50:46 +0100 Subject: [PATCH 09/10] Update CHANGELOG.md --- CHANGELOG.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d7179c3..c8482e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,11 @@ ## Changelog -### v6.0.0-beta1 (2021-10-07) -* upgrading node version to recommended node14 -* adding beta-node16 tag for beta testing node16 -* updating documentation +### v6.0.0 (2021-12-09) +* moving docu/ restructuring readme +* v6.0.0-beta1 (2021-10-07) + * upgrading node version to recommended node14 + * adding beta-node16 tag for beta testing node16 + * updating documentation * v5.3.0-beta1 (2021-10-07) * adding check (installed) PACKAGES on startup (#201) * adding packages for discovery adapter From 95451d052fee64a0b22de401a8772fd2fbe1558b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Germann?= Date: Thu, 9 Dec 2021 22:53:42 +0100 Subject: [PATCH 10/10] Update README_docker_hub_iobroker.md --- src/README_docker_hub_iobroker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/README_docker_hub_iobroker.md b/src/README_docker_hub_iobroker.md index bb33d55..35de2fd 100644 --- a/src/README_docker_hub_iobroker.md +++ b/src/README_docker_hub_iobroker.md @@ -11,7 +11,7 @@ # Important Note -New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at our new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/). +New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see the maintenance part of the new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/#maintenance). # Quick reference