Documentationalpha 0.7.7
Documentation
Guides and reference material for alpha 0.7.7, for the people who run the server, use the apps every day, or build them.
Manage the engine at http://SERVER:8080/console/ (/_/, the PocketBase dashboard address, also redirects there). Sign in with your directory account. The Pyrite pages sit alongside the engine’s PocketBase pages. Each person can choose a left sidebar or a top menu to reach Overview, Apps, Upload app, People, Groups, Units, Engine history, Backups, Analytics, Tools, Scheduled jobs, AI, Archive, Certificates, Network rules, Portal home and Engine settings. Owners can see everything. Admins (People Admin and App Admin) see only what their level allows. The Pyrite pages and the portal are available in English and Italian. Choose your language at the bottom of the page. Some labels may still change, so look for the function if a name differs.
01 /Guides and references
- Administrator guide
Requirements, first start, the console and the levels, units, two-factor authentication, people and groups, access, in-app roles, new apps and approval, network rules, the Windows firewall, HTTPS and Let’s Encrypt, the engine history, backup and restore, copying backups to a network folder, Pyrite as a Windows service, starting with nobody logged in and updating the engine.
- User guide
The portal, single sign-on, your profile, trying an Excel file, signing out and what to do if a message prevents you from signing in.
- Concepts
What Pyrite means by app, instance, gateway, directory, groups, roles, base level and tools.
- The app.json manifest
A reference for every field in the app manifest, including the
authsection, using the “Parts price list” app as an example. - Agent standard
Give this file to the AI agent building an app. It covers the rules, engine tools, languages, tests and the ZIP format for “Upload app”, with a bilingual sample app. The authoritative version is in English. An Italian translation is also available.
- Security and operations
Using the same hostname for the portal and apps, the firewall, central administration, the console and its access levels, app security restrictions and the limits of this alpha.
- Release notes
What’s new in alpha 0.7.7, 0.7.6, 0.7.5 and 0.7.4, and a short summary of earlier releases.
02 /Addresses
Replace SERVER with the IP address or hostname of the PC running the engine.
| Service | Address | Who can access it |
|---|---|---|
| Portal | http://SERVER:8080/ | Everyone. Restricted apps require sign-in. |
| Engine console | http://SERVER:8080/console/ | Owners and Admins only, using their directory accounts. |
| Individual apps | http://SERVER:<app port>/ | Depends on the app. Protected apps require an access grant. Open apps are available to the entire network. |
The portal lists the apps and their addresses. In the console, each app’s address appears at the top of its page. The engine usually runs on port 8080. Each app’s manifest specifies its port. Use the same hostname or the same IP address for both the portal and the apps. See Security and operations for the reason.
03 /Conventions
Folder paths are relative to the program folder that contains pyrite.exe. The path apps\<id> denotes an app folder, where <id> is the app’s identifier, for example apps\parts-pricelist.