Skip to main content

Connect the desktop client

If you started with start-desktop or python start.py --desktop, the desktop client is already open and connected to your local Hub. You can skip this page.

Read on if you want to:

  • run the desktop client on its own, from source;
  • connect a client to another Hub, for example a team Hub;
  • create accounts for other people.

Create accounts for other people​

In the admin console, open User management and choose New user. Create an account for each person who will use the client.

If you turned on self-registration and configured email, people can also choose Create account on the client's sign-in page.

Run the client from source​

Keep a Hub running. In another terminal:

cd client
npm ci
npm start

This works on all three desktop systems. On Windows you can also run client/start-soduwork.bat.

A client started this way keeps its own connection and settings, separate from the desktop-profile/ that --desktop uses.

You can also install the desktop client from the Download page.

Point the client at a Hub​

The client connects to http://127.0.0.1:18989 by default, which matches the source launcher. To use another Hub:

  1. On the sign-in page, choose Service connection · Change address.
  2. Enter the Hub address, for example http://127.0.0.1:18990 or https://work.example.com.
  3. Save, then sign in with an account on that Hub.

Enter only the address, without a username, password or /api. Use HTTPS for a Hub on another computer.

After signing in, you can switch between Local service and Team service in Settings → Service connection.

If the client shows Install and start a Runner in Agent management first., open Settings → Agent management and follow the prompt. The Runner is the part of the client that does the work on this computer.

The client home page

Check that it worked​

  • The home page shows What would you like SoduWork to do?
  • In the admin console, Execution network → Employee client lists your computer as Online.

Good to know​

  • Each Hub has its own accounts. Switching to another Hub doesn't move your data to it.
  • 127.0.0.1 means this computer only. Other computers can't reach a source Hub; for a team, use Docker.

Next​

Configure a model and a harness

Edit this page