Skip to content

adding support for obico - #2516

Open
a55uka wants to merge 3 commits into
community-scripts:mainfrom
a55uka:feat/obico
Open

a55uka wants to merge 3 commits into
community-scripts:mainfrom
a55uka:feat/obico

Conversation

@a55uka

@a55uka a55uka commented Nov 9, 2026

Copy link
Copy Markdown

✍️ Description

Adds a bare-metal install for the Obico self-hosted server - requested in community-scripts/ProxmoxVE#1581).

I have been running this with Bambuddy and the Obico integration all working for the past couple weeks!

🔗 Related PR / Issue

Link: community-scripts/ProxmoxVE#1581

✅ Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No breaking changes – Existing functionality remains intact.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🏗️ arm64 Support (X in brackets)

  • arm64 not tested - Assumed to work on arm64, but testing has not been done. All dependencies publish aarch64 pkgs and upstream ships arm64 images; var_arm64 is left unset.

🖥️ Tested on (X in brackets)

  • Proxmox VE – Created on a Proxmox VE host and the app works.
  • Incus – Created on an Incus host and the app works.

🛠️ Type of Change (X in brackets)

  • 🆕 New script – A fully functional and tested script or script set.

🔍 Code & Security Review (X in brackets)

  • Follows CODE-AUDIT.md & CONTRIBUTING.md guidelines
  • Uses correct script structure (AppName.sh, AppName-install.sh, AppName.json)
  • No hardcoded credentials
  • No Docker / Docker Compose – The application is installed bare-metal; Docker is not used.
  • No git pull – Updates use fetch_and_deploy_gh_branch (upstream publishes no releases/tags)

📋 Additional Information (optional)

  • The ML API is bound to 0.0.0.0:3333 because external clients (Bambuddy's Obico integration) call it directly; a generated ML_API_TOKEN in /opt/obico/.env gates every endpoint but the health check.
  • The default admin (root@example.com / supersecret) comes from an upstream migration; it is documented in the JSON notes with a change-it warning.
  • First run executes migrate, collectstatic, and manage.py site --add "$LOCAL_IP:3334" (the documented post-install step), then waits on /hc/ before reporting success.

📦 Application Requirements (for new scripts)

⚠️ Do not remove this section.
It is used by automated PR validation checks.
If this PR is not a new script submission, leave the checkboxes unchecked.

Required for 🆕 New script submissions.
Pull requests that do not meet these requirements may be closed without review.

  • The application is at least 6 months old - repo created 2020
  • The application is actively maintained - release branch promoted through 2026-10
  • The application has 1,000+ GitHub stars - ~1.9k
  • Official release tarballs are published - distribution is the release branch with built frontend bundles checked in, which is why fetch_and_deploy_gh_branch/check_for_gh_branch are used.
  • I understand that not all scripts will be accepted due to various reasons and criteria by the community-scripts ORG

🌐 Source


🤖 AI Assistance (X in brackets)

If you used an AI tool (GitHub Copilot, Claude, ChatGPT, etc.) to write or generate any scripts in this PR, you must confirm compliance below.
Select exactly one option.

Please describe to which degree, if any, an LLM was used in creating this pull request. Name the model(s) used and, if applicable, the reasoning/thinking effort level (e.g. "Claude Sonnet 4.5, high reasoning, used to draft the install script, then manually reviewed and tested" or "No LLM used"). This is informational, not a penalty — but scripts that are clearly AI-generated and not further revised by the author to match CODE-AUDIT.md / CONTRIBUTING.md may be closed without review.

Self-hosted Obico server (AI failure detection & remote monitoring for
OctoPrint/Klipper) as bare-metal install: daphne web, celery worker+beat,
redis, and the CPU (ONNX) ml_api, deployed from the upstream release branch.

Feature request: community-scripts/ProxmoxVE#1581
Bambuddy's Obico integration calls the ML API directly on :3333
(/hc/ must answer 'ok', /p/?img= for detection), so bind it to
0.0.0.0 — ML_API_TOKEN gates everything but the health check.
Note it in the JSON metadata.
@a55uka
a55uka requested a review from a team as a code owner November 9, 2026 15:13
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Try this script

ct/obico.sh, run in the Proxmox VE shell or on an Incus host:

COMMUNITY_SCRIPTS_URL=https://raw.githubusercontent.com/a55uka/DevScripts/feat/obico \
bash -c "$(curl -fsSL https://raw.githubusercontent.com/a55uka/DevScripts/feat/obico/ct/obico.sh)"

COMMUNITY_SCRIPTS_URL is not optional for ct/. Fetching the ct/ script from a
branch does not tell the engine where that branch is — with bash -c "$(curl …)"
there is no file on disk for the scripts root to be derived from, so it would fall
back to upstream main and look for the install script there.

Against a core branch as well

Add COMMUNITY_SCRIPTS_CORE_URL=https://raw.githubusercontent.com/OWNER/core/BRANCH
to test an engine change at the same time. The two resolve independently.

Useful flags while testing

dev_mode=net logs every fetch with status and duration, so you can confirm the
branch is really being used. dev_mode=keep stops a failed build from deleting
the container along with the evidence.

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

⚠️ Not ready for review yet

@a55uka, this pull request is missing the following:

  • Official release tarballs are published

Edit the PR description to fix it — no new PR needed. This check runs again on every edit and clears itself once everything is in place.

Until then the PR is marked stale and will be closed in 7 days.


@community-scripts/contributor please take a look: close it, comment, or set keep-open to keep it.

@github-actions github-actions Bot added requirements missing PR description misses template items; closes after 7 days unless fixed or keep-open stale new script labels Nov 9, 2026
@a55uka

a55uka commented Nov 9, 2026

Copy link
Copy Markdown
Author

sadly, no tarball release exists for obico, but nothing is built as it is just python,.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new script requirements missing PR description misses template items; closes after 7 days unless fixed or keep-open stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant