---
title: "Parity | Parity docs"
description: "What Parity is, what it needs, and the five commands that take an app from nothing to running the way Citadel runs it."
url: https://parity.apps.wayne.edu/docs/
llms: https://parity.apps.wayne.edu/llms.txt
generator: Squire agent-ready
---

# Parity [#](https://parity.apps.wayne.edu/docs/#parity)

Parity runs Citadel on your own computer: Citadel's own PHP image, Citadel's proxy headers and MySQL 5.6, driven by one program, `parity`, and one settings file in your app, `parity.json`. An app that works under Parity works on Citadel, because the parts that decide that are Citadel's own.

This page gets an app running. [Install](https://parity.apps.wayne.edu/docs/install.html) has every way to get the program; [Commands](https://parity.apps.wayne.edu/docs/reference/commands.html) has every option.

## What you need [#](https://parity.apps.wayne.edu/docs/#what-you-need)

- **Windows, macOS or Linux**, on x64 or arm64.
- **A container engine.** Podman Desktop (recommended, free), or Docker Desktop if you already have it. On Linux, Podman from your distribution, or Docker Engine with its Compose plugin. On Windows the engine runs on WSL 2.
- **Your app's folder.** Nothing else: no PHP, no Composer, no Node on your computer. Parity brings Citadel's.

## Five commands [#](https://parity.apps.wayne.edu/docs/#five-commands)

Run these in your app's folder.

```text
parity check        what to fix first, one finding per line, with the fix under it
parity init         writes parity.json, your app's Citadel settings
parity image get    downloads Citadel's image and checks it is Citadel's, byte for byte
parity up           builds and starts the app behind the proxy, then prints its address
parity test         smoke tests the running app through the proxy
```

`parity down` stops it at the end of the day. Your local database stays until you run `parity down --volumes`.

### 1. Check the computer [#](https://parity.apps.wayne.edu/docs/#1-check-the-computer)

`parity check` looks at the engine, Compose, Linux containers, WSL 2 on Windows, amd64 emulation on arm64, line endings in the files Citadel runs, and the ports Parity needs. It changes nothing.

```text
  Parity check  C:\Users\you\Development\my-app

  ✓ Docker Desktop 29.9.2 is running (linux/amd64, context desktop-linux).
  ✓ Docker Compose 5.6.1 is here.
  ✓ Linux containers, on WSL 2.
  ✓ This machine runs Citadel's amd64 images natively.

  Ready. This computer can be Citadel's twin.
```

When something needs fixing, each finding has its fix under it, for your OS. Fix the first one and run it again. [Troubleshooting](https://parity.apps.wayne.edu/docs/troubleshooting.html) explains the common ones.

### 2. Write parity.json [#](https://parity.apps.wayne.edu/docs/#2-write-parity-json)

`parity init` reads the folder (public folder, `build.sh`, `deployments/`, a health check, Laravel's writable folders, MySQL from `.env.example`) and writes `parity.json`. Preview it first with `parity init --print`. The fields mirror Citadel's app settings page, so checking it is a matter of holding it next to the dashboard. [parity.json](https://parity.apps.wayne.edu/docs/reference/parity-json.html) lists every field.

Coming from Squire's parity kit? Run `parity init --from-squire` instead: [Coming from Squire](https://parity.apps.wayne.edu/docs/guides/from-squire.html).

### 3. Get Citadel's image [#](https://parity.apps.wayne.edu/docs/#3-get-citadel-s-image)

`parity image get` downloads Citadel's image with your own git.wayne.edu access, then checks the file's sha256 and the loaded image's id against the catalog inside Parity. Only then does Parity call it Citadel's. [Citadel's images](https://parity.apps.wayne.edu/docs/guides/images.html) covers the three ways to download it.

Parity runs Citadel's own image and nothing else, so this step comes first. If Citadel has not published a download for your app's image yet, Parity says so and tells you what to do next ([When Citadel has not published an image yet](https://parity.apps.wayne.edu/docs/guides/images.html#when-citadel-has-not-published-an-image-yet)).

### 4. Bring it up [#](https://parity.apps.wayne.edu/docs/#4-bring-it-up)

`parity up` builds the app the way Citadel builds it, runs `deployments/`, starts MySQL and the proxy, waits for the health check, and prints the address:

```text
  Parity up  hello on citadel/php-apache:8.5r3

  ✓ Image  citadel/php-apache:8.5r3 matches Citadel (950dcf67937a)
  ✓ Build  app image built; build.sh ran as root with /bin/sh 4s
  ✓ MySQL  5.6.51 is ready on 127.0.0.1:3307, database hello 10s
  ✓ App    deployments ran, and healthy: php health.php said yes 4s
  ✓ Proxy  HAProxy answers, adding X-Forwarded-For and X-Forwarded-Proto as Citadel's does

  hello is up at http://localhost:8080
```

### 5. Test it [#](https://parity.apps.wayne.edu/docs/#5-test-it)

`parity test` requests the front page through the proxy, runs the app's health check, makes the requests listed in `parity.json`, and fails on any PHP fatal error in Apache's log while it ran. Exit 0 means all passed.

## Fake data only [#](https://parity.apps.wayne.edu/docs/#fake-data-only)

Parity ships no data, no connectors and no credentials. A local copy may point only at a test database its data owner approves, never production, and never real student or employee data on a laptop (FERPA). Parity never prints a configuration value and never bakes a configuration file into an image.

## Where to go next [#](https://parity.apps.wayne.edu/docs/#where-to-go-next)

- [How Parity works](https://parity.apps.wayne.edu/docs/guides/how-it-works.html): the three containers, mount and bake, and what lands in `.parity/`.
- [FAQ](https://parity.apps.wayne.edu/docs/faq.html): the questions people ask first.
- [Changelog](https://parity.apps.wayne.edu/docs/changelog.html): what changed in each release.
