Install Dev Space Agent

Here is the docker compose file

services:
  devspace-agent:
    container_name: devspace-agent
    image: mcr.microsoft.com/dotnet/runtime:8.0
    command: sh -c "ln -sf /usr/libexec/docker/cli-plugins/docker-compose /usr/bin/docker-compose && dotnet DevSpaceAgent.dll"
    volumes:
      - ./:/app:ro
      - ./Data:/app/Data:rw
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /usr/bin/docker:/usr/bin/docker:ro
      - /usr/libexec/docker/cli-plugins/docker-compose:/usr/libexec/docker/cli-plugins/docker-compose:ro
      - /var/lib/docker/volumes/portainer_data/_data/compose:/var/lib/docker/volumes/portainer_data/_data/compose:ro
      - /var/lib/docker/volumes/portainer_data/_data/custom_templates:/var/lib/docker/volumes/portainer_data/_data/custom_templates:ro
    working_dir: /app
    restart: on-failure:3
    networks:
      - devspace-agent_network
    ports:
      - 5555:5555
    dns:
      - 1.1.1.2
      - 1.0.0.2
networks:
  devspace-agent_network:
    name: devspace-agent_network
    driver: bridge

Install Dev Space Agent

You can can install the agent service on any linux server running docker that you want to manage from the dashboard.

Upload the agent files to your server.
Open the server terminal and go to the agent folder using cd /agent for example.
Run docker compose up -d to start the agent.
You should see Container devspace-agent Started this confirms that it's working.
You can now add your agent server to the Dev Space dashboard under your own team using the provided server ip and the agent key that will be created in the agent folder on your server in Data/Config.json

Update Dev Space Agent

You can easily update the agent with a small package which will show up in your server home page.

Go to the Dev Space Agent folder.
Run docker compose down
Upload and overwrite the current files with the new ones.
Run docker compose up -d

PreviousAgent Guides NextPermissions

Last updated 18 days ago

services: devspace-agent: container_name: devspace-agent image: mcr.microsoft.com/dotnet/runtime:8.0 command: sh -c "ln -sf /usr/libexec/docker/cli-plugins/docker-compose /usr/bin/docker-compose && dotnet DevSpaceAgent.dll" volumes: - ./:/app:ro - ./Data:/app/Data:rw - /var/run/docker.sock:/var/run/docker.sock:ro - /usr/bin/docker:/usr/bin/docker:ro - /usr/libexec/docker/cli-plugins/docker-compose:/usr/libexec/docker/cli-plugins/docker-compose:ro - /var/lib/docker/volumes/portainer_data/_data/compose:/var/lib/docker/volumes/portainer_data/_data/compose:ro - /var/lib/docker/volumes/portainer_data/_data/custom_templates:/var/lib/docker/volumes/portainer_data/_data/custom_templates:ro working_dir: /app restart: on-failure:3 networks: - devspace-agent_network ports: - 5555:5555 dns: - 1.1.1.2 - 1.0.0.2 networks: devspace-agent_network: name: devspace-agent_network driver: bridge