Skemik¶
Skemik is a database that ships its own data model: 30
curated schema.org types, edited in an admin and served as JSON-LD, Markdown,
CSV or HTML at one address, /feed, where programs with a key can write too.
It has no frontend by intent: a website, a shop or an assistant is built on the
feed and runs elsewhere. It is written in PHP, keeps its data in SQLite and
needs no daemon and no cron job. Skemik is source available under the Business
Source License 1.1 and each release becomes AGPLv3 on the Change Date stamped
in its LICENSE.
Prerequisites¶
Skemik needs PHP 8.5. Switch to it:
[isabell@moondust ~]$ uberspace tool php version set 8.5
OK: Set version of php to 8.5
The extensions it needs, pdo_sqlite, intl, dom and mbstring, and the
optional ones, fileinfo, gd, openssl, sodium and phar, are all
installed on Uberspace 8.
The address you run the installer under becomes the install's own: login mails name it and the updater asks it. If you want to use your own domain, set it up first:
[isabell@moondust ~]$ uberspace web domain list
Domain
────────────────────
isabell.uber.space
Installation¶
Check the latest version on the releases page and download it:
[isabell@moondust ~]$ cd /var/www/virtual/$USER/
[isabell@moondust isabell]$ VERSION="1.0.16" # This number can differ!
[isabell@moondust isabell]$ wget "https://github.com/plue-gmbh/skemik/releases/download/${VERSION}/skemik-${VERSION}.zip"
[...] ‘skemik-1.0.16.zip’ saved [...]
Tip
Every release is signed with minisign.
If you have it on your own computer, download the zip and its .minisig
there too and check them before you go on:
[localuser@localhost ~]$ minisign -Vm skemik-1.0.16.zip -P RWTcPiN2NJok7rtTpL5Ipn/LHlDpGfDQGT2ZHkbGp1Lry05p4J71nMzW
Signature and comment signature verified
Trusted comment: version 1.0.16 commit 27bbf09af3ac6a9a3a97dfe7244ad41214009abe
Later releases are checked against the same key by the updater itself.
Unpack the zip and copy everything in its folder, including the hidden
.htaccess, into your document root. The /. copies the folder's contents
rather than the folder:
[isabell@moondust isabell]$ unzip -q "skemik-${VERSION}.zip"
[isabell@moondust isabell]$ rm -f html/nocontent.html
[isabell@moondust isabell]$ cp -a "skemik-${VERSION}/." html/
[isabell@moondust isabell]$ rm -r "skemik-${VERSION}" "skemik-${VERSION}.zip"
SHA256SUMS lists every file of the release but .htaccess. Check the copy
against it; --quiet prints only what differs, so no output means every file
arrived:
[isabell@moondust isabell]$ cd html
[isabell@moondust html]$ sha256sum --quiet -c SHA256SUMS
Skemik keeps its data in a folder of its own, outside the document root. The installer never creates it, and accepts only an empty one:
[isabell@moondust html]$ mkdir ~/skemik-data
Warning
Run the installer right away. Until it has run, the install belongs to
whoever opens /install first.
Open https://isabell.uber.space/install in your browser. It checks the server
first and stores nothing until every check passes. Then give it:
- Data folder:
/home/isabell/skemik-data, - Name and Login address: yours, as the install's owner,
- the timezone and the admin's language.
The installer writes config.php into the document root, readable only by your
user, and sends your first login code by mail. The code is also written to
~/skemik-data/login/, in case the mail is slow.
Configuration¶
Every field stays inside the install until it is made public. To see the feed work, open Events in the admin, tick Public on Name and Starts, add an event and set its status to Published. Then read it from your own computer, with no key:
[localuser@localhost ~]$ curl https://isabell.uber.space/feed/en-US/events
{
"@context": "https://schema.org",
"@type": "ItemList",
[...]
en-US is the locale the installer took from your browser; /feed lists the
ones your install holds.
Login codes go out through PHP's mail(), which delivers on Uberspace without
further setup. An SMTP relay can be set on the admin's General screen.
Debugging¶
If something goes wrong, you might find some clues:
- on Skemik's error page, which shows a six-character incident id; the owner's Error log screen finds the entry by that id,
- in
~/skemik-data/log/app.log, the same log as a file, - in
~/logs/php_error.log, or withjournalctl --user --unit php-fpm.
If /install answers with Apache's own error page, the .htaccess was not
copied. Check that it is in /var/www/virtual/$USER/html/.
Updates¶
Note
Check the update feed regularly.
Skemik updates itself. Once an hour it asks releases.skemik.org for the
newest release, checks its signature, takes a snapshot of your data and
installs it, keeping the lines you added to .htaccess outside its own block.
The check sends nothing that identifies your install. The Updates screen,
opened from the Settings card on the admin's home screen, says when it last
checked and what it installed, and turns the automatic updates off.
To update by hand, take a snapshot on the Backups screen, then download and
unpack the next release as shown under Installation and copy it over the
old one. config.php and the data folder are left alone; the first request
moves your data to the new version.
Further Reading¶
- Skemik's README: the whole documentation, from reading and writing the feed to building a website on it
- Demo install: a feed to read before you install
- Issues: reports and questions