English

Русский

English

Русский

Appearance

Usage ​

Installation ​

There are different ways to install components on a server, VPS, etc.

1. Automatic installation ​

shell
curl -sSLH "X-Key: _placeholder_key_" https://oxmix.net/api/nodes/connect | sudo sh -
shell
wget -qO- --header="X-Key: _placeholder_key_" https://oxmix.net/api/nodes/connect | sh
  • The command downloads the shell script and executes it through the sh shell
  • The script checks if Docker Engine is installed; if not, it installs the latest version
  • The script checks if Netip components are installed and installs or updates them if necessary

Replace the key

Don't forget to replace the placeholder _placeholder_key_ with your key

Source code of the shell script

Check the source code of the script https://oxmix.net/api/nodes/connect

shell

2. Using cloud-init ​

Runcmd

This is a section in CloudInit that takes a list of commands and executes them sequentially after other system initialization processes are completed

Replace the key

Don't forget to replace the placeholder no-set-key with your key

yaml
Script execution logs

Installing components

shell
tail -f /var/log/cloud-init-netip.log

Output cloud-init log

shell
tail -f /var/log/cloud-init-output.log

3. Manual installation ​

Execute the script manually in the terminal

Docker Engine >= 20.0 is required to be installed

Replace the key

Don't forget to replace the placeholder no-set-key with your key

Show the one-liner script
shell

Disabling Components ​

To exclude a component from installation, for example device, simply add header X-Off: device or multiple components like X-Off: network,device to the URL curl -H "X-Off: device" https://oxmix.net/api/nodes/connect

core - the component is mandatory

To exclude from other installation options (2, 3), you need to manually delete the runs from the scripts

Configuring Components ​

Certain components can be configured additionally.

netip.network component ​

By default, after installation, it is added to the Default group, this can be changed:

  • using the installer

Add a header in curl: -H "X-Fwg: Default,My custom group"

  • manually

You can additionally add it to another group during the first installation of the component: -e FIREWALL_GROUPS='Default, My custom group'

Important

If the component netip-network was previously installed on the node, adding to the groups Default My custom group will not happen automatically, it must be added manually

Do not use the firewall

To avoid adding the node to any groups and effectively disable the firewall during installation, you can pass an installer header with an empty value: -H "X-Fwg: "

Updating components ​

Similarly to the installation, it will perform an update when run through the terminal

shell
curl -sSLH "X-Key: _placeholder_key_" https://oxmix.net/api/nodes/connect | sudo sh -
shell
wget -qO- --header="X-Key: _placeholder_key_" https://oxmix.net/api/nodes/connect | sh

Removing Components ​

All components will be stopped and removed

shell
curl -sSL https://oxmix.net/api/nodes/connect?purge | sudo sh -
shell
wget -qO- https://oxmix.net/api/nodes/connect?purge | sh