# docker-obico

**Repository Path**: G7010/docker-obico

## Basic Information

- **Project Name**: docker-obico
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-23
- **Last Updated**: 2024-07-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Obico Docker Images

[![Build](https://github.com/gabe565/docker-obico/actions/workflows/build.yml/badge.svg)](https://github.com/gabe565/docker-obico/actions/workflows/build.yml)

This repo builds Docker images for [TheSpaghettiDetective/obico-server](https://github.com/TheSpaghettiDetective/obico-server) to be used in hosting environments that do not support building a local image.

The Obico git ref is automatically updated by Renovate bot, so new Obico releases will be available within a few hours of a push to the Obico release branch.

## Images

- [ghcr.io/gabe565/obico/web](https://github.com/gabe565/docker-obico/pkgs/container/obico%2Fweb)
- [ghcr.io/gabe565/obico/ml-api](https://github.com/gabe565/docker-obico/pkgs/container/obico%2Fml-api)

## Deployment

### Docker

These images are built very similarly to the [`docker-compose.yml`](https://github.com/TheSpaghettiDetective/obico-server/blob/release/docker-compose.yml) provided by Obico.

The main difference is that the server container in this repo does not require a volume bind at `/frontend`. Those files are built directly into the container image.

#### Usage

1. Copy [`.env.example`](.env.example) to `.env`.
2. Edit the file and set the desired values.
3. Run `docker compose up`.
   - If you want Obico to run in the background, add the `-d` flag.
   - Note that this step will take a while due to the size of the Obico images.
4. When ready, the web UI will be available at http://localhost:3334.
   - Default email: `root@example.com`
   - Default password: `password`.
5. Data will be stored in the `data` directory.

### Kubernetes

I have built a Helm chart for Kubernetes deployments. See [charts.gabe565.com](https://charts.gabe565.com/charts/obico/) or [gabe565/charts](https://github.com/gabe565/charts/tree/main/charts/obico) for details.