Host a private index

A private Sysand index is a directory of project files served over HTTP that sysand can install projects from. Unlike sysand.com, an index hosted this way is static: it does not expose an API for publishing, so sysand publish cannot be used with it. Projects are added to the index with sysand index add.

Two ways to run one

How you maintain the index depends on who publishes to it:

• Host it yourself: Host a static index yourself. You run sysand index add and put the result where it is served. Simple, no infrastructure, and a good fit when one person (or a small trusted group) curates the index.

• Run a reviewed team index: The reviewed team index model. Contributors submit built packages through a pull or merge request; automation validates each one and maintains the index; review is the publishing gate. A good fit when several people publish and you want a record and an approval step. Ready-made example repositories implement this for GitHub and GitLab.

Both produce the same kind of static index, so consumers install the same way (sysand add <IRI> --index <url>), differing only in the access control on the URL. See Indexes for configuring an index permanently in sysand.toml.

Note

This page is only concerned with hosting the project files in the structure that sysand can understand. Hosting a front-end website (such as the Sysand Index at sysand.com) is not a part of these guides.