Skip to content

Contributing to Eight.ly

Eight.ly OS's source (imogenlabs/eightly), its app-template catalog (imogenlabs/eightly-templates), and this wiki's own source are all private repositories today. There's no public GitHub Issues board and no pull request queue to open against them. This page tells you what you actually can do right now.

Report a bug

Use Discord. Include:

  • What you did and what you expected vs. what happened
  • Your Eight.ly OS version — check the dashboard footer or Settings, or run eosctl system version / curl http://box.example.lan:8080/api/system/version (see eosctl and API Reference); don't guess at a version
  • Relevant logs — eosctl system logs (see eosctl), or the web terminal

Report a security issue

Do not post a suspected vulnerability on Discord or anywhere public. Use one of:

  1. A private GitHub Security Advisory at https://github.com/imogenlabs/eightly/security/advisories/new
  2. Email [email protected]

Include a description of the issue, reproduction steps, the affected version, and any supporting logs or output. The product repo's own SECURITY.md has the full scope and response-time targets, including a machine-readable policy at https://os.eight.ly/.well-known/security.txt.

Propose a feature

Also via Discord — describe the use case, not just the feature. Discuss the approach before assuming it'll be built the way you imagine.

Improve this wiki

The wiki's source is private too, so there's no PR to open directly — but the same Discord channel is the way to flag a wrong or stale page, suggest what to add, or point out something missing. If you'd rather write the fix yourself, ask there first; that's also the fastest way to get it merged.

Contribute code that actually ships in the open

HomelabARR CE is the open lane. It's free and open source, carries the whole app catalogue, and is the project that feeds Eight.ly OS's App Store. If you want to contribute code, app configurations, or documentation that anyone can see land, that's where it happens — check its own repository for contribution guidelines.

There is currently no public way to contribute code directly to Eight.ly OS itself.

Community

Support the project

Support on Ko-fi helps fund development time, infrastructure, and maintenance, if you'd like to support the project without writing code.

Related reading: Architecture for how the system fits together, API Reference for the HTTP API, and eosctl / the MCP server for scripting and AI-assistant access instead of the dashboard.