@gatelab/agent
v1.0.0
Published
GateLab self-hosted agent for running containers on your own infrastructure
Maintainers
Readme
GateLab Agent
Self-hosted agent for running GateLab containers on your own infrastructure.
Installation
npm install -g @gatelab/agentQuick Start
- Register your server in the GateLab dashboard
- Configure the agent with your credentials:
gatelab-agent configure --server-id YOUR_SERVER_ID --api-key YOUR_API_KEY- Start the agent:
gatelab-agent startCommands
configure
Configure the agent with GateLab credentials.
gatelab-agent configure --server-id <id> --api-key <key> [--api-url <url>] [--port <port>]Options:
--server-id(required): Server ID from GateLab registration--api-key(required): API key from GateLab registration--api-url: GateLab API URL (default: https://api.gatelab.io)--port: Local agent port (default: 3001)
start
Start the GateLab agent.
gatelab-agent startstatus
Check agent and Docker status.
gatelab-agent statuslist
List all managed containers.
gatelab-agent listlogs
View container logs.
gatelab-agent logs <container> [-n <lines>]stop
Stop a container.
gatelab-agent stop <container>reset
Reset agent configuration.
gatelab-agent resetEnvironment Variables
You can also configure the agent using environment variables:
GATELAB_SERVER_ID: Server IDGATELAB_API_KEY: API keyGATELAB_API_URL: API URL (default: https://api.gatelab.io)GATELAB_AGENT_PORT: Agent port (default: 3001)GATELAB_HEARTBEAT_INTERVAL: Heartbeat interval in ms (default: 30000)
Requirements
- Node.js 18+
- Docker
Configuration File
Configuration is stored at ~/.gatelab/agent.json with restricted permissions (600).
License
MIT
