Stand up a gateway
Create an identity, write a configuration, start Gateway Fabric, and confirm it is healthy, in five steps.
In this guide you start a Gateway Fabric peer that keeps your organization's data available for devices that connect later. Each step names what you should see before you move on.
Before you start
| You need | Why |
|---|---|
The atlas-gateway-fabric executable | It runs the gateway and its setup commands. |
| A folder the service owns | The gateway keeps its identity and local data there. |
| An organization administrator | They provision credentials for the gateway's identity. |
Write the configuration
Create gateway.toml. The name and database_url fields are required. The WebSocket listener must be enabled explicitly, because it is off by default even though ws is the default uplink.
[gateway]
name = "field-gateway"
data_dir = "/var/lib/atlas-gateway-fabric"
[storage]
database_url = "sqlite:fabric.db"
[transport.uplink]
transport = "ws"
[transport.ws]
enabled = true
bind_addr = "0.0.0.0:9443"
[health]
enabled = true
bind_addr = "127.0.0.1:8080"
Outcome: a file the gateway can load. Use absolute paths for a managed service, and restrict the health listener to the local machine as shown.
Create the identity
Load or create the gateway's durable identity and print its DID.
atlas-gateway-fabric -c gateway.toml init
Outcome: the gateway's DID. This command does not give the gateway any organization authority. Send the DID to your organization administrator so they can provision its credentials.
Check the configuration
Parse and print the configuration, then exit.
atlas-gateway-fabric -c gateway.toml status
Outcome: your settings echoed back. This only parses the file. It does not contact a running gateway or check that listeners can bind, and it prints the database URL, so redact any credentials before sharing the output.
Start the gateway
Start the runtime. It validates the uplink selection, loads the provisioned credentials, and starts serving.
atlas-gateway-fabric -c gateway.toml start
Outcome: a running gateway. Start fails if the credentials do not match the identity, or if the ws uplink is selected without [transport.ws] enabled.
Confirm it is healthy
Check the health listener on the address you configured, then connect a device to the WebSocket listener.
Outcome: a healthy response from the health listener, and your device syncing through the gateway. A configured listener does not prove every stream mode works, so match your device's protocol and feature profile to the gateway.
Next steps
- Review every setting in the configuration reference.
- Understand carriers, sessions and the operational peer in the architecture overview.
- Connect external systems with integrations.
- Add MQTT, TLS and client feature requirements from the configuration reference.