f.weber/homebrewery
0
0
Fork 0
mirror of https://github.com/naturalcrit/homebrewery.git synced 2025-12-24 18:32:41 +00:00
Code Wiki Activity

Updates to docker files and cooresponding documentation.

Browse Source
This commit is contained in:
David Bolack
2024-12-20 21:30:19 -06:00
parent 674fb6ff57
commit 2bedc6d7d4
3 changed files with 92 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Dockerfile
View File

@@ -1,4 +1,4 @@
FROM node:20-alpine FROM node:22-alpine
RUN apk --no-cache add git RUN apk --no-cache add git
ENV NODE_ENV=docker ENV NODE_ENV=docker
@@ -9,8 +9,10 @@ WORKDIR /usr/src/app
# Copy package.json into the image, then run yarn install # Copy package.json into the image, then run yarn install
# This improves caching so we don't have to download the dependencies every time the code changes # This improves caching so we don't have to download the dependencies every time the code changes
COPY package.json ./ COPY package.json ./
COPY config/default.json config/default.json COPY config/docker.json usr/src/app/config
# --ignore-scripts tells yarn not to run postbuild. We run it explicitly later # --ignore-scripts tells yarn not to run postbuild. We run it explicitly later
RUN node --version
RUN npm --version
RUN npm install --ignore-scripts RUN npm install --ignore-scripts
# Bundle app source and build application # Bundle app source and build application

132
README.DOCKER.md
View File

@@ -1,64 +1,76 @@
# Offline Install Instructions: Docker # Offline Install Instructions: Docker
These instructions are for setting up a persistent instance of the Homebrewery application locally using Docker. These instructions are for setting up a persistent instance of the Homebrewery application locally using Docker.
If you intend to develop with Homebrewery, following the Homebrewery application section of this guide is not recommended. Using docker to deploy MongoDB locally for development is not a bad idea at all, however. If you intend to develop with Homebrewery, following the Homebrewery application section of this guide is not recommended. Using docker to deploy MongoDB locally for development is not a bad idea at all, however.
# Install Docker # Install Docker
## Docker Desktop (MacOS/Windows) ## Docker Desktop (MacOS/Windows)
Windows and Mac installs use Docker Desktop. Current install instructions are below. Windows and Mac installs use Docker Desktop. Current install instructions are below.
* [Mac](https://docs.docker.com/desktop/mac/install/) * [Mac](https://docs.docker.com/desktop/mac/install/)
* [Windows](https://docs.docker.com/desktop/windows/install/) * [Windows](https://docs.docker.com/desktop/windows/install/)
You can set up the docker engine to start on boot via the Docker desktop UI. You can set up the docker engine to start on boot via the Docker desktop UI.
## Docker Engine ## Docker Engine
Linux installs use Docker Engine. Docker provides installers and instructions for several of the most common distrubutions. If you do not see yours listed, it is very likely supported indirectly by your distribution. Linux installs use Docker Engine. Docker provides installers and instructions for several of the most common distrubutions. If you do not see yours listed, it is very likely supported indirectly by your distribution.
* [Arch](https://docs.docker.com/desktop/setup/install/linux/archlinux/) * [Arch](https://docs.docker.com/desktop/setup/install/linux/archlinux/)
* [CentOS](https://docs.docker.com/engine/install/centos/) * [CentOS](https://docs.docker.com/engine/install/centos/)
* [Debian](https://docs.docker.com/engine/install/debian/) * [Debian](https://docs.docker.com/engine/install/debian/)
* [Fedora](https://docs.docker.com/engine/install/fedora/) * [Fedora](https://docs.docker.com/engine/install/fedora/)
* [RHEL](https://docs.docker.com/engine/install/rhel/) * [RHEL](https://docs.docker.com/engine/install/rhel/)
* [Ubuntu](https://docs.docker.com/engine/install/ubuntu/) * [Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
### Post installation steps ### Post installation steps
[Manage Docker as a non-root user (highly recommended)](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) [Manage Docker as a non-root user (highly recommended)](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
[Enable Docker to start on boot (highly recommended)](https://docs.docker.com/engine/install/linux-postinstall/#configure-docker-to-start-on-boot) [Enable Docker to start on boot (highly recommended)](https://docs.docker.com/engine/install/linux-postinstall/#configure-docker-to-start-on-boot)
# Build Homebrewery Image # Build Homebrewery Image
Next we build the homebrewery docker image. Start by cloning the repository. Next we build the homebrewery docker image. Start by cloning the repository.
```shell ```shell
git clone https://github.com/naturalcrit/homebrewery.git git clone https://github.com/naturalcrit/homebrewery.git
cd homebrewery cd homebrewery
``` ```
Make an changes you need to `config/default.json` then build the image. Make an changes you need to `config/docker.json` then build the image. If it does not exist,the below as a template.
```shell ```
docker-compose build homebrewery {
``` "host" : "localhost:8000",
"naturalcrit_url" : "local.naturalcrit.com:8010",
"secret" : "secret",
"web_port" : 8000,
"enable_v3" : true,
"mongodb_uri": "mongodb://172.17.0.2/homebrewery",
"enable_themes" : true,
}
```
# Add Mongo container ```shell
docker-compose build homebrewery
```
Once docker is installed and running, it is time to set up the containers. First up, Mongo. # Add Mongo container
```shell Once docker is installed and running, it is time to set up the containers. First up, Mongo.
docker run --name homebrewery-mongodb -d --restart unless-stopped -v mongodata:/data/db -p 27017:27017 mongo:latest
```
Older CPUs may run into an issue with AVX support. ```shell
``` docker run --name homebrewery-mongodb -d --restart unless-stopped -v mongodata:/data/db -p 27017:27017 mongo:latest
WARNING: MongoDB 5.0+ requires a CPU with AVX support, and your current system does not appear to have that! ```
see https://jira.mongodb.org/browse/SERVER-54407
see also https://www.mongodb.com/community/forums/t/mongodb-5-0-cpu-intel-g4650-compatibility/116610/2 Older CPUs may run into an issue with AVX support.
see also https://github.com/docker-library/mongo/issues/485#issuecomment-891991814 ```
WARNING: MongoDB 5.0+ requires a CPU with AVX support, and your current system does not appear to have that!
see https://jira.mongodb.org/browse/SERVER-54407
see also https://www.mongodb.com/community/forums/t/mongodb-5-0-cpu-intel-g4650-compatibility/116610/2
see also https://github.com/docker-library/mongo/issues/485#issuecomment-891991814
``` ```
If you see a message similar to this, try using the bitnami mongo instead. If you see a message similar to this, try using the bitnami mongo instead.
@@ -66,19 +78,19 @@ If you see a message similar to this, try using the bitnami mongo instead.
docker run --name homebrewery-mongodb -d --restart unless-stopped -v mongodata:/data/db -p 27017:27017 bitnami/mongo:latest docker run --name homebrewery-mongodb -d --restart unless-stopped -v mongodata:/data/db -p 27017:27017 bitnami/mongo:latest
``` ```
If your distribution is running on an arm device such as a Raspberry Pi, you will need to run the arm-built MongoDB v4.4. If your distribution is running on an arm device such as a Raspberry Pi, you will need to run the arm-built MongoDB v4.4.
```shell ```shell
docker run --name homebrewery-mongodb -d --restart unless-stopped -v mongodata:/data/db -p 27017:27017 arm64v8/mongo:4.4 docker run --name homebrewery-mongodb -d --restart unless-stopped -v mongodata:/data/db -p 27017:27017 arm64v8/mongo:4.4
``` ```
## Run the Homebrewery Image ## Run the Homebrewery Image
```shell ```shell
# Make sure you run this in the homebrewery directory # Make sure you run this in the homebrewery directory
docker run --name homebrewery-app -d --restart unless-stopped -e NODE_ENV=docker -v $(pwd)/config/docker.json:/usr/src/app/config/docker.json -p 8000:8000 docker.io/library/homebrewery:latest docker run --name homebrewery-app -d --restart unless-stopped -e NODE_ENV=docker -v $(pwd)/config/docker.json:/usr/src/app/config/docker.json -p 8000:8000 docker.io/library/homebrewery:latest
``` ```
## Updating the Image ## Updating the Image
When Homebrewery code updates, your docker container will not automatically follow the changes. To do so you will need to rebuild your homebrewery image. When Homebrewery code updates, your docker container will not automatically follow the changes. To do so you will need to rebuild your homebrewery image.
@@ -86,22 +98,22 @@ First, return to your homebrewery clone (from Build Homebrewery Image above) or
First, delete the existing image. First, delete the existing image.
```shell ```shell
docker rm -f homebrewery-app docker rm -f homebrewery-app
``` ```
Next, update the clone's code to the latest version. Next, update the clone's code to the latest version.
```shell ```shell
cd homebrewery cd homebrewery
git checkout master git checkout master
git pull upstream master git pull upstream master
``` ```
Finally, rebuild and restart the homebrewery image. Finally, rebuild and restart the homebrewery image.
```shell ```shell
docker-compose build homebrewery docker-compose build homebrewery
docker run --name homebrewery-app -d --restart unless-stopped -e NODE_ENV=docker -v $(pwd)/config/docker.json:/usr/src/app/config/docker.json -p 8000:8000 docker.io/library/homebrewery:latest docker run --name homebrewery-app -d --restart unless-stopped -e NODE_ENV=docker -v $(pwd)/config/docker.json:/usr/src/app/config/docker.json -p 8000:8000 docker.io/library/homebrewery:latest
``` ```

1
docker-compose.yml
View File

@@ -1,4 +1,3 @@
version: '2'
services: services:
mongodb: mongodb:
image: mongo:latest image: mongo:latest