Homedir

DevRel, OpenSource, InnerSource Community Platform

Homedir is a Quarkus-based community platform for DevRel/Open Source initiatives, combining Community Picks, Events, Projects, CFP workflows, GitHub Trending repositories, and contributor identity integrations (GitHub/Discord/Google login) in a single product.

Repository Layout

• quarkus-app/: main Quarkus application (backend + templates + static assets).
• docs/: product and technical documentation (EN/ES).
• platform/: VPS deployment scripts, env template, systemd/nginx assets.
• tools/community-curator/: curated content generation and deployment tooling.

Getting Started

1) Run locally with Quarkus (Developer Mode)

Prerequisites:

• JDK 21
• Maven 3.9+ (or use the included Maven Wrapper)

git clone https://github.com/os-santiago/homedir.git
cd homedir
mvn -f quarkus-app/pom.xml quarkus:dev

Open http://localhost:8080.

For local auth in dev mode, you can use:

• [email protected] / userpass
• [email protected] / adminpass

2) Run using public Quay images

Public image repository:

• quay.io/sergio_canales_e/homedir

Tags published by release pipeline:

• latest
• semantic tags like 3.360.1 (see Releases)

Create an env file from platform/env.example and fill required values (do not commit secrets), then run:

docker run --rm --name homedir \
  -p 8080:8080 \
  --env-file ./.env.homedir \
  -v "$(pwd)/.data:/work/data" \
  quay.io/sergio_canales_e/homedir:latest

You can pin a specific release tag:

docker run --rm --name homedir \
  -p 8080:8080 \
  --env-file ./.env.homedir \
  -v "$(pwd)/.data:/work/data" \
  quay.io/sergio_canales_e/homedir:3.360.1

3) Build your own image from source

Build a JVM image with the project Dockerfile:

docker build -f quarkus-app/src/main/docker/Dockerfile.jvm \
  -t homedir:local \
  quarkus-app

Run it:

docker run --rm --name homedir-local \
  -p 8080:8080 \
  --env-file ./.env.homedir \
  -v "$(pwd)/.data:/work/data" \
  homedir:local

Push your own image to Quay:

docker login quay.io
docker tag homedir:local quay.io/<your-namespace>/homedir:<tag>
docker push quay.io/<your-namespace>/homedir:<tag>

Documentation

Canonical documentation language: English. Spanish documentation is maintained as a mirror (full translation or stub).

• English Documentation
• Documentación en Español
• Documentation Language Policy
• Release Stage Gates (Alpha -> Beta -> RC -> GA)

Platform deployment notes:

• platform/README.md
• Production-Safe Delivery Playbook

Contributing

We welcome contributions! Please see our Contributing Guidelines for details on how to get started, our development workflow, and contribution guidelines.

Code of Conduct

We are committed to fostering a welcoming and inclusive community. Please read our Code of Conduct to understand the standards of behavior we expect from all community members.

Security

We take security seriously. Please see our Security Policy for responsible disclosure guidelines and security contact information.

Contributors

Thanks to all our contributors!

---

Homedir: Where code finds its home.