The SYNTROPY NETWORK Developer Hub

Welcome to the SYNTROPY NETWORK developer hub. You'll find comprehensive guides and documentation to help you start working with SYNTROPY NETWORK as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Documentation

Install with Ansible

Install with Ansible

If you are using Ansible for provisioning, Syntropy provides a simple way for you to get your network configured


Mandatory Variables

In order to successfully install Syntropy with Docker, you must have an API Key

Variable Name

Description

SYNTROPY_API_KEY

SYNTROPY Network Agent Token (String)

👍

API Key Example

SYNTROPY_API_KEY=nQlSAezB8yxncfPPW#$2mKR4UTqEQ2R5


Installation

ansible-playbook syntropy-agent.yaml -f 10
---
hosts: all
# tasks file for syntropy-agent
tasks:
    - name: pull an image
    docker_image:
        name: syntropynet/agent:stable
        force_source: yes

    - name: Stop and remove old container
    docker_container:
        name: syntropy-agent
        state: absent
        image: syntropy-agent

    - name: Create Syntropy agent container and connect to network
    docker_container:
        name: syntropy-agent
        restart_policy: unless-stopped
        image: syntropynet/agent:stable
        network_mode: "host"
        purge_networks: no
        env:
        SYNTROPY_API_KEY: <<agent_token>>
        SYNTROPY_NETWORK_API: docker
        volumes:
        - /var/run/docker.sock:/var/run/docker.sock:ro
        devices:
        - "/dev/net/tun:/dev/net/tun"
        capabilities:
        - net_admin
        - sys_module

Updated 7 months ago


Next step

Customize your installation with Syntropy Agent Variables

Syntropy Agent Variables

Install with Ansible


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.