What the install page shows

What the install page shows: the tag, the proxy locations, the size.

# What the install page shows

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-install

`GET /api/v1/sites/{site}/install`

What the install page shows: the tag, the proxy locations, the size.

## Parameters

- `site` (in path, needed): A site's id or name

## The answer

200, `InstallView`: Everything the install page shows (SC-18).

- `caddy` (string, needed)
- `caddy_html` (string)
- `ceiling` (integer, needed): It is never over this: a build that grows it fails.
- `check_html` (string)
- `csp` (list of string, needed): The content policy lines a page needs.
- `csp_html` (string): The content policy's lines, the `integrity` attribute and the command that checks a page, highlighted the same way (doc/polish.md, C13: one look for code).
- `fields` (list of FieldDef, needed): What the script sends, all of it.
- `gzipped` (integer, needed): The script's size as a browser receives it.
- `integrity` (string, needed): For the tag's `integrity` attribute, for this site's switches.
- `integrity_html` (string)
- `nginx` (string, needed): The two locations for nginx.
- `nginx_html` (string)
- `nix` (string or null): The declaration for our own NixOS module. Only on an instance of our own: customers never see it.
- `site` (string, needed)
- `tag` (string, needed): The one line for the head of every page, served from the site's own domain.
- `tag_direct` (string, needed): The same, loading the script from tidekeeper directly.
- `tag_direct_html` (string): The same lines, highlighted as HTML for a code card, by the server (doc/sign-in-services.md, B.4): the direct line an attribute to a line, the line from the site's own domain, and the two servers' parts.
- `tag_html` (string)
- `version` (string, needed)

## Asking

```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/install \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

Parameters

sitein the address

neededA site's id or name

The answer

Status 200

InstallView Everything the install page shows (SC-18).

caddy

stringneeded

caddy_html

string

ceiling

integerneededIt is never over this: a build that grows it fails.

check_html

string

csp

list of stringneededThe content policy lines a page needs.

csp_html

stringThe content policy's lines, the `integrity` attribute and the command that checks a page, highlighted the same way (doc/polish.md, C13: one look for code).

fields

list of FieldDefneededWhat the script sends, all of it.

gzipped

integerneededThe script's size as a browser receives it.

integrity

stringneededFor the tag's `integrity` attribute, for this site's switches.

integrity_html

string

nginx

stringneededThe two locations for nginx.

nginx_html

string

nix

string or nullThe declaration for our own NixOS module. Only on an instance of our own: customers never see it.

site

stringneeded

tag

stringneededThe one line for the head of every page, served from the site's own domain.

tag_direct

stringneededThe same, loading the script from tidekeeper directly.

tag_direct_html

stringThe same lines, highlighted as HTML for a code card, by the server (doc/sign-in-services.md, B.4): the direct line an attribute to a line, the line from the site's own domain, and the two servers' parts.

tag_html

string

version

stringneeded

Asking

curl https://tidekeeper.eu/api/v1/sites/example.org/install \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/install", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());