Quick start
From nothing to a board of apps in about two minutes.
1. Start it
monoki run --state-dir ./monoki-state --addr 127.0.0.1:8080
Open http://127.0.0.1:8080.
2. Create the admin account
The first visit shows a setup form. Fill it in and you are signed in.
That form is the only unauthenticated write path monoki has, and it stops working the moment an account exists — so nobody who finds your instance later can claim it. There is no open sign-up: from here on, an admin creates accounts. See Users & roles.
If you would rather do this headlessly:
monoki create-admin --username andre
3. Add your first app
Your account starts with a group called My Apps. Add something to it:
- Click Add app, or press
n, or just paste a URL anywhere on the board — pasting is the fastest path and the one the product is built around. - Type or paste the link. A moment later the name and icon fill themselves in.
- Press Add to board.
If the page can't be read — the app is off, it is behind a login, it has no favicon — you get a sensible name from the hostname and a coloured letter tile. Saving is never blocked by a failed lookup. See Icons & titles.
4. Arrange it
Drag a tile to move it. Or focus one and hold Shift while pressing an arrow
key, which does exactly the same thing without a mouse. Everything on the board
is reachable from the keyboard — see Keyboard shortcuts.
5. Make a second group
Click the + in the group rail. Groups are separate boards: Home, Media,
Infra. Press 1–9 to jump between them.
Drag a tile onto another group's tab to move it there, or use the tile's Move to menu.
6. Share one
Say your partner should be able to open the media apps but not rearrange them.
- Create a user for them: Users → New user (admin only).
- Open the group you want to share and click Share.
- Search their username and click Add as viewer.
They now see that group on their own board, marked with who shared it, and can open everything on it. They cannot add, edit, reorder, or remove anything.
If you want them to be able to add apps too, choose editor instead. Either way they can never rename the group, delete it, or share it onward — those stay yours. The full model is in Groups & sharing.
7. Put it somewhere real
Local-only is fine forever. If you want it on your network or on a domain, add a reverse proxy — Running behind a proxy — and read Security first.