Browse documentation

🧭 Start Here

Blackcap Overview ✨ Blackcap Feature Catalog Installation First Run

🚀 Deploy Blackcap

Platform Stacks and Raspberry Pi Hardware Raspberry Pi Deployment Raspberry Pi Client Services GCP Deployment Application Updates Environment Variables and Secrets Reverse Proxy and TLS Background Jobs and Schedules

🛠️ Administer Blackcap

Organizations Users, Permissions, and Authentication Configuration Workspace Backups and Restore Database Administration Regression Testing Performance and Job Status Audit, Access Activity, and Logging GeoIP and Access Location Data Retention and Purge Support Requests API Tester and Postman Instance Reporting

🍽️ Use Recipes

Recipes and the Recipe Library Recipe Import and Discovery Recipe Editing and Cache Artifacts Recipe Sharing Social Recipe Import AI Recipe Image Generation

📅 Plan Meals

🛒 Use Shopping Lists

Shopping Lists and Shop a List External and Household Shopping 🧩 Chrome Extension Shop With

🧺 Manage Kitchen Inventory

🧺 Kitchen Inventory

🖥️ Use Displays

Displays and Connections Assigning and Scheduling Display Content Remote Pi Client E-Ink Rendering Menu Refresh and Rendering Noun Project Footer Images

🧑‍🍳 Cook with Let’s Cook

🧑‍🍳 Let’s Cook 🧑‍🍳 Let’s Cook Controls and Timers

🤖 Use and Administer AI

🤖 AI in Blackcap 🤖 AI Providers and Connections 🤖 AI Seeds and Usage

🧩 Use the Chrome Extension

🧩 Blackcap Chrome Extension 🧩 Chrome Extension Recipe Capture 🧩 Chrome Extension Shop With 🧩 Chrome Extension Release and Privacy

🎮 Play Games

🎮 Games and Trivia

🔌 Integrations

Email Integration Cloud Storage Integrations Voice Assistants Shop With Integrations Authentication Providers

⚙️ Develop Blackcap

Application Architecture Database Service and Data Access SQLite and PostgreSQL Database Migrations Background Job Architecture Testing API Architecture Security and Organization Scoping UI, Icons, and Documentation Assets Blackcap-Safe Emoji Documentation Standards Terminology

⚠️ Troubleshoot Blackcap

⚠️ Troubleshooting Deployment Troubleshooting Display Troubleshooting Recipe Import Troubleshooting 🤖 AI Troubleshooting Backup Troubleshooting Database Troubleshooting Diagnostic Organization Clones Support Requests

Installation

Audience: Deployment Administrator Related: Raspberry Pi · Gcp · Environment And Secrets · First Run

Use the repository deployment scripts for a new installation. They install the required operating-system packages, create or update the Python virtual environment, prepare /etc/blackcap/blackcap.env, initialize configuration, install systemd units, run idempotent database migrations, and configure scheduled operations.

Use tools/deploy_pi.sh for a Raspberry Pi server and tools/deploy_gcp.sh for a GCP application host. Review the target-specific guide before running a script. Never commit the generated environment file or provider credentials.

Raspberry Pi

cd /home/pi/Blackcap-Pi
sudo ./tools/deploy_pi.sh

The script prompts for the service user, public URL, menu schedule, local e-ink role, remote Let’s Cook watcher, package installation, stunnel, and Gunicorn proxy behavior.

GCP

cd /opt/Blackcap
sudo ./tools/deploy_gcp.sh

The script prompts for the Cloud SQL connection, PostgreSQL credentials, private-IP use, public hostname, Nginx/HTTPS setup, certificate automation, schedules, and remote Let’s Cook watcher.

Manual verification

sudo systemctl status inky_admin.service --no-pager
sudo journalctl -u inky_admin.service -n 100 --no-pager

On this page