Skip to main content

2. Remote Arcane host (optional)

Now, you can of course create a docker compose file in your ARR VM, however Arcane also offers to possibility to manage other docker vm's as well. Then you directly get all the benefits of resource and update management for your ARR VM as well. This is not necessary but highly recommended for ease of use. Hence, we will show you here how to create a remote arcane host s.t we can deploy our ARR stack via the arcane Webgui instead of via the cli ;)

1. Go to your Arcane Manager host and log in 

2. Next we will go to Environments > + Add Environment

3. Give it a name e.g "arr"

4. Next add the ARRVM IP address with a port you want to run it on e.g 3553 e.g 10.20.34.90:3553

5. Then click on generate agent configuration which will provide a docker compose file you can use for your Arr VM. 

6. Copy the generated compose file

7. Enter your Arr VM with ssh

8. Create a new folder called arcane

mkdir arcane

9. Inside of the arcane folder create a new docker compose file and copy paste the generated compose file

nano compose.yml

10. Then as an example it looks like this

compose.yml 
services:
  arcane-agent:
    image: ghcr.io/getarcaneapp/agent:latest
    container_name: arcane-agent
    restart: unless-stopped
    environment:
      - AGENT_MODE=true
      - EDGE_TRANSPORT=poll
      - AGENT_TOKEN=arc_f18ea27f48b812813a6d6c1099b7ad0972beb22b6c532d1d253e6e89fb8f6fbe
      - MANAGER_API_URL=https://arcane.example.org
      - PUID=1000
      - GPID=1000
    ports:
      - "3553:3553"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /opt/docker:/app/data

11. Now, for the volumes you need to give it access to your docker sock as with the arcane manager and also again the volume you want to store all your projects in. I chose for /opt/docker but you can choose whatever you like of course. In that folder you specify arcane will create a projects folder. 

12. Also I added my user and group ID that I use with PUID and GPID both setting to a 1000. This is necessary to make sure you don't have permissions issues.

13. Then simply start the arcane agent container with

docker compose up -d

14. Then go back to your Arcane manager and click on test connection. It should then show online if everything went well ;)

15. Then the last step to actually start working inside your arr vm you need to go back to your dashboard and select the arr Environment ;)

16. Alright! Then let's make a new project on the next page

No comments to display