Skip to main content

[TOC]


Latest NOIA Agent Docs

Prerequisites

  • Wireguard kernel module is installed and loaded:
lsmod | grep wireguard
  • Optional: Docker is installed and running:
docker system info

Limitations

  • Docker network subnets can't overlap.
  • 10.69.0.0/16 is used for internal Wireguard network

Steps


1. Login to https://platform.noia.network

2. Create API key (Settings > API keys)

3. Install NOIA Agent

Possible Docker Container versions:

Stable: noia/agent:stable

Development: noia/agent:devel or noia/agent:latest

With Docker
docker run --network="host" --restart=on-failure:10 \ 
--cap-add=NET_ADMIN --cap-add=SYS_MODULE \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
--device /dev/net/tun:/dev/net/tun \
--name=noia-agent \
-e NOIA_API_KEY='z99CuiZnMhe2qtz4LLX43Gbho5Zu9G8oAoWRY68WdMTVB9GzuMY2HNn667A752EA' \
-e NOIA_NETWORK_API='docker' \
-d noia/agent:stable

Check agent logs:

docker logs noia-agent

More information: https://docs.noia.network/docs/start-noia-agent#install-with-docker


With Docker-compose

With Portainer agent:

curl  https://gitlab.com/noia-public/platform_agent/-/raw/master/docker-compose/na-pa.yml \
-o docker-compose.yaml

Without portainer agent:

curl  https://gitlab.com/noia-public/platform_agent/-/raw/master/docker-compose/noia-agent.yaml \
-o docker-compose.yaml

Edit docker-compose.yaml file and edit these environment variables:

NOIA_API_KEY= your_api_key

Start containers:

docker-compose up -d

Check agent logs:

docker logs noia-agent

P.S. NOIA Agent will ignore the default docker network, you will need to create a separate network with different subnets on different hosts. Also, subnet 10.69.0.0/16 is used by our agent.

More information:

https://docs.noia.network/docs/start-noia-agent#install-as-docker-compose


With pip
pip3 install platform-agent

Download systemd service file:

curl https://gitlab.com/noia-public/platform_agent/-/raw/master/systemd/noia-agent.service -o /etc/systemd/system/noia-agent.service

Create noia-agent directory:

mkdir /etc/systemd/system/noia-agent.service.d/
chmod -R 600 /etc/systemd/system/noia-agent.service.d/

Download settings file:

curl https://gitlab.com/noia-public/platform_agent/-/raw/master/systemd/10-vars.conf -o /etc/systemd/system/noia-agent.service.d/10-vars.conf

Edit settings file /etc/systemd/system/noia-agent.service.d/10-vars.conf and change these settings:

[Service]
# Required parameters
Environment=NOIA_API_KEY=YOUR_API_KEY
# Optional parameters
Environment=NOIA_CONTROLLER_URL=controller-prod-platform-agents.noia.network
Environment=NOIA_ALLOWED_IPS=[{"10.0.44.0/24":"oracle_vpc"},{"192.168.111.2/32":"internal"}]
#If using docker , NOIA_NETWORK_API=docker would allow agent to access docker networks for information.
Environment=NOIA_NETWORK_API=none
Environment="NOIA_AGENT_NAME=Azure EU gateway"

# Select one of providers from the list - https://noia-network.readme.io/docs/start-noia-agent#section-variables
Environment="NOIA_PROVIDER=1"

Environment=NOIA_LAT=40.14
Environment=NOIA_LON=-74.21
Environment=NOIA_TAGS=Tag1,Tag2
Environment=NOIA_SERVICES_STATUS=false
systemctl  daemon-reload
systemctl enable --now noia-agent

Check if service is running:

systemctl status noia-agent

More information: https://docs.noia.network/docs/start-noia-agent#install-with-pip


Metadata

Release files for platform-agent 0.0.64

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for platform-agent 0.0.64
File Size Uploaded Provenance Actions
platform-agent-0.0.64.tar.gz 24.8 kB Without provenance Details for platform-agent-0.0.64.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for platform-agent 0.0.64
File Interpreter ABI Platform Actions
platform_agent-0.0.64-py3-none-any.whl Python 3 none any Details for platform_agent-0.0.64-py3-none-any.whl

Total release size: 64.0 kB

Release files / platform-agent-0.0.64.tar.gz

Download URL platform-agent-0.0.64.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7ba1eaa6a3c063f43e9b4f11534b618551922586ce86bfbc4a9c76738649e9ee
BLAKE2b-256 checksum
How to use checksums
2fd3391fcaf8e6efcc79dc82c9dd5f538cf6861485117bb8a64424176e500d09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.6.8

Release files / platform_agent-0.0.64-py3-none-any.whl

Download URL platform_agent-0.0.64-py3-none-any.whl
Size 39.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6bebd3a3cb40efc315d868d1d698ed5d932ba9bcc95f133382ade97329d2a69d
BLAKE2b-256 checksum
How to use checksums
c86c057e98677f989b485edd4245514e207faca8b562f911eef8697cbdfa2eaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.6.8

Security for platform-agent 0.0.64

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.64 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page