https://github.com/camatcode/hex_tiny
Test environment docker images for private Hex repos and Hex.pm itself
https://github.com/camatcode/hex_tiny
docker docker-compose elixir erlang hexpm
Last synced: 2 months ago
JSON representation
Test environment docker images for private Hex repos and Hex.pm itself
- Host: GitHub
- URL: https://github.com/camatcode/hex_tiny
- Owner: camatcode
- License: apache-2.0
- Created: 2025-05-28T18:48:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-07T01:48:32.000Z (about 1 year ago)
- Last Synced: 2025-06-07T02:37:59.903Z (about 1 year ago)
- Topics: docker, docker-compose, elixir, erlang, hexpm
- Language: Dockerfile
- Homepage:
- Size: 120 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hex_tiny & hex_beefy
Two containerized Hex package repository/api images for testing and development.
## Table of Contents
- [Overview](#overview)
- [Quick Start](#quick-start)
- [hex_tiny](#hex_tiny)
- [hex_beefy](#hex_beefy)
- [CI/CD Integration](#cicd-integration)
- [Why?](#why)
## Overview
**hex_tiny** - A lightweight single-image Hex repository server based on the [Hex: Self Hosting](https://hex.pm/docs/self-hosting) guide. Provides "repository" functionality.
- Docker Hub: [camatcode/hex_tiny](https://hub.docker.com/r/camatcode/hex_tiny)
- Port: 8000
**hex_beefy** - A full-featured test environment running [hexpm/hexpm](https://github.com/hexpm/hexpm/tree/main) with integrated PostgreSQL database.
- Docker Hub: [camatcode/hex_beefy](https://hub.docker.com/r/camatcode/hex_beefy)
- Port: 4000
## Quick Start
### hex_tiny
**Direct Docker:**
```bash
docker run -it --network=host camatcode/hex_tiny
# Or specify port: docker run -it -p {port}:8000 camatcode/hex_tiny
```
**Docker Compose:**
```bash
# Start
docker compose -f docker-compose_tiny.yml up -d
# View logs
docker compose -f docker-compose_tiny.yml logs -f
# Stop
docker compose -f docker-compose_tiny.yml down
```
Access at: http://localhost:8000/
--------
### hex_beefy
**Direct Docker:**
```bash
docker run -it --network=host camatcode/hex_beefy
# Or specify port: docker run -it -p {port}:4000 camatcode/hex_beefy
```
**Docker Compose:**
```bash
# Start
docker compose -f docker-compose_beefy.yml up -d
# View logs
docker compose -f docker-compose_beefy.yml logs -f
# Stop
docker compose -f docker-compose_beefy.yml down
```
Access at: http://localhost:4000/
**Test emails:** http://localhost:4000/sent_emails
**Test user:** With docker tag **:with_test_user** - username: "test_user" password: "elixir1234" admin for org called "test_org"
**Pitfalls:**
* If you publish documentation to a package, it will say you published it, but will not store the docs (so you can't retrieve what you posted)
## CI/CD Integration
Example usage in GitHub Actions: [aura's workflow](https://github.com/camatcode/aura/blob/main/.github/workflows/ci.yml#L27)
## Why
I needed this to use as a reference API implementation to execute against (because testing against Hex.pm itself is rude).
My CI/CD in this case is really limited (can't compose or launch services), so everything had to work in one image.