# NoticeOS

> Install, use and operate NoticeOS, the self-hosted app that shows traffic, revenue, costs, alerts and work for your websites and software products in one place.

A self-hosted app that shows traffic, revenue, costs, alerts and work in one place, on your laptop, phone or TV.

## Table of Contents

### Start

- [What is NoticeOS](https://docs.notice.cx/start/what-is-noticeos.md): A self-hosted app that shows traffic, revenue, costs, alerts and work for your websites and software products in one place.
- [Install in five minutes](https://docs.notice.cx/start/quickstart.md): Go from a machine with Docker to the first number on a site's Overview, with one command and no checkout.
- [Install with Docker](https://docs.notice.cx/start/install-with-docker.md): Set up NoticeOS with one Docker command, with no checkout, Node or pnpm, and run, update and roll it back through its folder's launcher.
- [Install from source](https://docs.notice.cx/start/install-from-source.md): Set up a new NoticeOS installation on any Docker host with one command, and learn what that command creates.
- [Run with Docker](https://docs.notice.cx/start/run-with-docker.md): How a NoticeOS installation runs as its Docker Compose stack: the installation folder, moving an existing installation into it, controlling the stack and moving the app to new code from main.
- [Try the demo](https://docs.notice.cx/start/try-the-demo.md): Explore NoticeOS with synthetic sites in a read-only public demo, or host your own demo on a Linux server.
- [Upgrade](https://docs.notice.cx/start/upgrade.md): Move an existing installation to newer NoticeOS code safely, apply database changes as a separate step, and go back if you need to.

### Guides

- [Add your first site](https://docs.notice.cx/guides/add-your-first-site.md): Add a website to NoticeOS from Home in one step, and see what the product sets up for it.
- [Connect data sources](https://docs.notice.cx/guides/connect-data-sources.md): Connect traffic, search, product and revenue sources once, match them to your sites, and read what each status word means.
- [Connect Google](https://docs.notice.cx/guides/connect-google.md): Sign in with Google once to collect Search Console and GA4 data for every site the account can see.
- [Connect a task project](https://docs.notice.cx/guides/connect-a-task-project.md): Give a site's code repository its own task list on the shared board, so people and agents in that checkout work from the same tasks you see.
- [Connect an agent](https://docs.notice.cx/guides/connect-an-agent.md): Give a coding agent on this machine your tasks, site reports and each site's data panel through MCP, with no task tool or credential of its own.
- [Send your own report](https://docs.notice.cx/guides/send-your-own-report.md): Have a product report its own daily counts to NoticeOS, in the exact shape the product accepts, and see where they show up.
- [Measure your codebase](https://docs.notice.cx/guides/measure-your-codebase.md): Send a weekly measurement of a site's code to NoticeOS and read the Codebase tab: size, repeated code, unused code, hard-to-change functions and tests, beside the site's visitors.
- [Record revenue and costs](https://docs.notice.cx/guides/record-revenue-and-costs.md): Where revenue is collected automatically, and how to declare the subscriptions and domain orders that no connected service reports.
- [Arrange the Wall](https://docs.notice.cx/guides/arrange-the-wall.md): Drag, stack, split and resize the TV view's widgets on a scaled copy of the TV screen, save the layout as a version, and check it still fits the screen.
- [Choose your view](https://docs.notice.cx/guides/choose-your-view.md): Choose which pages, parts of Home, site tabs and TV layout the Tower shows: I run the business, I build the product or Everything.

### The Tower

- [The Tower](https://docs.notice.cx/tower.md): What the Tower is, how to open it, and where to find each part of it.
- [Home](https://docs.notice.cx/tower/home.md): How the business is doing, what is broken and what needs your attention, drawn from your sites' data.
- [Workflows](https://docs.notice.cx/tower/workflows.md): What NoticeOS runs on its own for your sites and your work, when each one runs next, and how its runs went.
- [Sites](https://docs.notice.cx/tower/sites.md): Which sites need your attention, and one site's own page: its status, its numbers and its tabs.
- [Alerts](https://docs.notice.cx/tower/alerts.md): What fired, how serious it is, what kind of thing it is, and what you did about it.
- [Tasks](https://docs.notice.cx/tower/tasks.md): The shared board of work across your projects: what is waiting for you, what is blocked, and how to file a task.
- [Agents](https://docs.notice.cx/tower/agents.md): Who did the work: the tasks each agent holds, its closed tasks over eight weeks, the week's ranking of agents and models, and the evidence for every close.
- [Money](https://docs.notice.cx/tower/financials.md): The month's net, where revenue and cost come from, and the costs you declare.
- [System health](https://docs.notice.cx/tower/health.md): Whether NoticeOS itself is working: its connections, its scheduled jobs, the sources no provider account collects, expiring credentials and data spend.
- [Integrations](https://docs.notice.cx/tower/integrations.md): What you are connected with, whether each connection works, and where to connect something new.
- [Settings](https://docs.notice.cx/tower/settings.md): The portfolio-wide settings: your view, the time zone, the budgets, the alert rules, collection schedules, the TV, ownership, task projects and the installation.
- [TV dashboard](https://docs.notice.cx/tower/wall.md): The Wall: the summary view for a television, a laptop or a phone, and what each tile means.

### Operate

- [Daily operations](https://docs.notice.cx/operate/daily-operations.md): Check, read, restart and update a running NoticeOS installation with its own commands, from a checkout or through its folder's launcher.
- [Backups and restore](https://docs.notice.cx/operate/backups-and-restore.md): What the nightly backup captures, where it goes, how long it is kept, and how to rehearse a restore.
- [Scheduled jobs](https://docs.notice.cx/operate/scheduled-jobs.md): What NoticeOS collects and checks on a schedule, where you change those schedules, and what happens after downtime.
- [Budgets and the kill switch](https://docs.notice.cx/operate/budgets-and-the-kill-switch.md): The one spending cap NoticeOS enforces today, the alert thresholds to tune, and how to stop things when you need to.
- [Secrets and credentials](https://docs.notice.cx/operate/secrets-and-credentials.md): Which four secrets start NoticeOS, where every provider credential is stored, how to check them, and how to rotate the encryption key.
- [Troubleshooting](https://docs.notice.cx/operate/troubleshooting.md): The states and stop messages you will see while running NoticeOS, what each one means, and what to do about it.

### Concepts

- [How NoticeOS works](https://docs.notice.cx/concepts/how-noticeos-thinks.md): The five-step loop NoticeOS runs for your sites, what it never changes on its own, and why an unknown number is never recorded as zero.
- [Alerts](https://docs.notice.cx/concepts/alerts.md): What an alert is, why NoticeOS raises so few, and what each button on an alert does.
- [Attribution and measurement](https://docs.notice.cx/concepts/attribution-and-measurement.md): Why shipping a change is not a result, how an outcome check works, and why "could not be measured" is an accurate result you will see often.
- [Tasks and agents](https://docs.notice.cx/concepts/tasks-and-agents.md): How the shared task board links a finding to a task, a change and its outcome, and what AI agents may and may not do in NoticeOS today.
- [Glossary](https://docs.notice.cx/concepts/glossary.md): The words you meet on NoticeOS screens and in these docs, each in a sentence or two.

### Reference

- [Commands](https://docs.notice.cx/reference/commands.md): Every command the repository offers, generated from package.json and each script's own header.
- [Configuration](https://docs.notice.cx/reference/configuration.md): Every setting the Tower may edit, generated from the one declaration of the configuration registers.
- [Release and upgrade policy](https://docs.notice.cx/reference/release-policy.md)

### Design library

- [Design library](https://docs.notice.cx/design.md)
- [00 — Objective & the ROI ledger](https://docs.notice.cx/00-objective-and-roi.md)
- [01 — Architecture: a closed loop around a ledger](https://docs.notice.cx/01-architecture.md)
- [02 — The signal contract](https://docs.notice.cx/02-signal-contract.md)
- [03 — Attribution & evaluation](https://docs.notice.cx/03-attribution.md)
- [04 — Decision policy & context](https://docs.notice.cx/04-decision-policy.md)
- [05 — Execution, autonomy & accountability](https://docs.notice.cx/05-execution-and-accountability.md)
- [06 — Operations & self-observability](https://docs.notice.cx/06-operations.md)
- [07 — Roadmap](https://docs.notice.cx/07-roadmap.md)
- [08 — SEO / SERP / GEO signal reference](https://docs.notice.cx/08-seo-geo-signals.md)
- [09 — Onboarding a site](https://docs.notice.cx/09-onboarding-a-site.md)
- [10 — Control Tower UX](https://docs.notice.cx/10-control-tower.md)
- [11 — Integrations & their economics](https://docs.notice.cx/11-integrations.md)
- [13 — Opportunity scouting](https://docs.notice.cx/13-opportunity-scouting.md)
- [Design](https://docs.notice.cx/14-design.md)
- [16 — Replacing the chat workflow](https://docs.notice.cx/16-replacing-the-chat-workflow.md)
- [20 — Signal panels: the read contract for property repos](https://docs.notice.cx/20-signal-panels.md)
- [NoticeOS Workflows](https://docs.notice.cx/22-workflows-research-and-design.md)
- [23 — Workspace ownership and authorized execution](https://docs.notice.cx/23-configuration-ownership.md)
- [24 — Integration monitoring](https://docs.notice.cx/24-integration-monitoring.md)
- [26 — Storage capacity and transition sizing](https://docs.notice.cx/26-storage-capacity.md)
- [27 — Codebase health](https://docs.notice.cx/27-codebase-health.md)
- [NoticeOS — the Notice identity](https://docs.notice.cx/brand.md)