Skip to content

getting-started.md

Latest commit

 

History

History
105 lines (66 loc) · 2.97 KB

getting-started.md

File metadata and controls

105 lines (66 loc) · 2.97 KB

Getting Started

For background information, see the What is Beszel? page.

1. Start the hub

The hub can be run with a single binary file or with Docker / Podman.

2. Create an admin user

After starting the hub, navigate to http://localhost:8090 or your chosen address.

You will be prompted to create an account:

Screenshot of user creation form

3. Configure your first system

Click the Add System button in the top right corner to open the system creation dialog. We're using a local unix socket in this example, but you can use a remote agent instead.

Note: As of 0.12.0, you can also use a universal token (/settings/tokens) to connect the agent to the hub without needing to configure it ahead of time.

Screenshot of system creation form

4. Start the agent

:::: details Docker instructions

::: tip NOTE If you prefer to set up containers in a different way, please feel free to do so. :::

  1. Copy the docker-compose.yml content from the Add System dialog.

  2. Create a directory somewhere to store the agent's docker-compose.yml file.

mkdir beszel-agent
cd beszel-agent
  1. Create a docker-compose.yml file and paste in the content provided in the Add System dialog.

::: code-group

nano docker-compose.yml
vim docker-compose.yml
emacs docker-compose.yml
code docker-compose.yml

:::

  1. Start the agent.
docker compose up -d

::::

:::: details Binary instructions ::: warning The install script is for Linux only If you use a different OS, please manually download and run the correct binary for your system. See the Agent Installation page or the Compiling page for more information. :::

  1. Copy the binary install command from the Add System dialog.

  2. Open a terminal and run the command.

This will download the correct binary, create a user called beszel, and start the agent. It also creates a service to keep it running after reboot, and optionally enables automatic daily updates. ::::

5. Finish adding the system

Now that the agent is running, click the Add System button in the dialog.

You will see the new system in table. If it flips to green, you're good to go.

Screenshot of system creation form

If it changes to red, check the Common Issues page.