121 lines
5.3 KiB
Markdown
121 lines
5.3 KiB
Markdown
# Accounts and the portal
|
|
|
|
The optional portal lets you open an instance from [fluksio.com](https://fluksio.com),
|
|
including a pip installation with no local dashboard. The instance connects
|
|
outward over a WebSocket, so you do not need to open an inbound port.
|
|
|
|
Flows still run on your instance. The portal serves the interface and carries
|
|
API requests, responses and live updates through the connection.
|
|
|
|
## Connect an instance
|
|
|
|
1. Sign up or sign in at **fluksio.com**.
|
|
2. Open **Instances → Add instance** and copy the code.
|
|
3. On the machine running Fluksio, open another terminal in the same directory
|
|
as `fluksio serve` and run:
|
|
|
|
```sh
|
|
fluksio enroll <code>
|
|
```
|
|
|
|
The CLI uses the `https://hub.fluksio.com` by default. If you started the engine
|
|
with `--data-dir` or `--global`, use the same option when enrolling. A running
|
|
engine picks up the connection automatically; otherwise start it with
|
|
`fluksio serve`.
|
|
|
|
From a local dashboard, you can instead use **Settings → Remote access**:
|
|
leave the default portal URL, paste the code, and press **Connect**.
|
|
Enrollment requires a superuser account.
|
|
|
|
The portal owner's sessions use the local account that enrolled the instance.
|
|
Check **Acting as** under Remote access. With several local superusers, the
|
|
CLI can choose one explicitly:
|
|
|
|
```sh
|
|
fluksio enroll <code> --as someone@example.com
|
|
```
|
|
|
|
A new valid code replaces an existing connection. An expired or invalid code
|
|
leaves the current connection intact. Once connected, open the instance from
|
|
the portal's **Instances** list.
|
|
|
|
## Let someone else in
|
|
|
|
Each person gets an ordinary local account, with no superuser rights. You can
|
|
admit them in either of these ways:
|
|
|
|
- Share an invitation link from the portal's **Instances** list.
|
|
- Ask them for a code from **Instances → Join an instance**. Enter it on your
|
|
local instance under **Settings → Remote access → Add remote user**.
|
|
|
|
Their account appears under **Admin → Users** with a *Portal* badge. They
|
|
sign in through the portal rather than with a local password. Invitations are
|
|
time-limited; generate a fresh one if it expires.
|
|
|
|
Somebody admitted by a link gets their local account the first time they open
|
|
the instance. Until then they are listed under **Admin → Users → Pending portal
|
|
members**, where you can revoke the invitation.
|
|
|
|
If a local user already has their email, they are refused rather than handed
|
|
that account. A superuser can press **Link portal account** beside them to let
|
|
them in as that user, who keeps their local password. Superuser accounts
|
|
cannot be linked. A linked user counts as a portal user from then on, so
|
|
removing them at the portal, or disconnecting, deletes them.
|
|
|
|
## Hooks and agents through the portal
|
|
|
|
The portal also forwards a flow's hooks and the MCP endpoint, so they work
|
|
without an inbound port. Replace `portal.example.com` with your portal's API
|
|
address in these examples:
|
|
|
|
- A webhook or a served WebSocket:
|
|
`https://portal.example.com/i/<instance-id>/hooks/<flow>/<url>/<secret>`,
|
|
with `wss://` for a socket.
|
|
- An agent: `https://portal.example.com/i/<instance-id>/mcp`, see
|
|
[Agents over MCP](../code/agents.md).
|
|
|
|
Through the portal a hook needs a [secret](../reference/node-types.md#http).
|
|
A hook without one answers only on the instance's own address; through the
|
|
portal it gets the same 404, or closed socket, as a wrong secret. The instance
|
|
id is the one in the address when you open the instance from the portal.
|
|
|
|
## Manage or end remote access
|
|
|
|
**Settings → Remote access** shows the connection status and the latest
|
|
connection error. The instance needs outbound access to the portal, and any
|
|
proxy on that route must support WebSockets.
|
|
|
|
- To remove a person's access, remove them from the portal's sharing dialog,
|
|
which also deletes their local account while the instance is connected, or
|
|
delete or deactivate their account under **Admin → Users**.
|
|
- To end all portal access from the instance, press **Disconnect**. This stops
|
|
the connection and invalidates portal credentials locally, without requiring
|
|
the portal to be online. It also deletes the users the portal let in; the
|
|
account that enrolled and every superuser stay.
|
|
- To replace the pairing, use **Connect with a new code**. Remote users and
|
|
devices paired through the portal may need to pair again.
|
|
|
|
If the instance is removed at the portal, or its code is renewed there, the
|
|
status reads **Removed at the portal** and the instance stops dialling. Connect
|
|
with a new code to restore remote access.
|
|
|
|
Local sign-in and flows continue after disconnecting. Portal requests follow
|
|
the instance's normal account permissions. The instance verifies portal tokens
|
|
against the portal's signing keys, which it pins during enrollment and takes
|
|
again from the portal each time it connects.
|
|
|
|
## Custom portals
|
|
|
|
The CLI accepts another compatible portal with `--portal https://<portal-host>`;
|
|
the dashboard has the same URL field. HTTPS is required except for a portal on
|
|
loopback.
|
|
|
|
This public repository contains the instance and its connector. The portal
|
|
service is not included, so the Docker stack does not start one.
|
|
|
|
## See also
|
|
|
|
- [The fluksio command](../code/cli.md): data directories and enrollment options.
|
|
- [Dashboards and devices](dashboards.md): pair a wall screen through the portal.
|
|
- [Getting started](../getting-started/index.md): install and open your first instance.
|