# Install adam:ONE® on VyOS®

**URL:** <https://support.adamnet.works/t/install-adam-one-on-vyos/898>\
**Category:** KB & Manual\
**Created:** [June 9, 2023, 6:30pm UTC](https://support.adamnet.works/t/install-adam-one-on-vyos/898 "2023-06-09T18:30:53Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![atw](https://support.adamnet.works/user_avatar/support.adamnet.works/atw/32/233_2.png) [@atw](https://support.adamnet.works/u/atw)\
**Post date:** [June 9, 2023, 6:30pm UTC](https://support.adamnet.works/t/install-adam-one-on-vyos/898/1 "2023-06-09T18:30:53Z")

</div>

### Supported Versions

- VyOS v1.4
- VyOS v1.5

## Preparation

You will want the following information to complete this guide.

- Interface IP addresses that you want the DNS service to run on. For basic networks this would be the IP address of the router on your LAN interface.

- LAN interfaces. This might just be `eth1` for a single LAN port. For VLANs it might also include something like `eth1.20` for VLAN 20 on eth1. To see a full list of interfaces and IP addresses on your router, use the following command in operational mode.

- LAN subnets. For example it might just be a single network of `192.168.1.0/24` or multiple such as `10.0.0.0/24,10.10.10.0/24`. Include any IPv6 separately such as `2001:db8:1:2::/64`.

## Compatibility

The conntrack helpers must be disabled. [As stated in the VyOS docs](https://docs.vyos.io/en/latest/configexamples/ha.html#configure-conntrack-sync-and-enable-helpers) “Conntrack helper modules are enabled by default, but they tend to cause more problems than they’re worth in complex networks”  
To disable the helper modules go into configure mode and delete the config as follows.

```bash
configure
delete system conntrack modules
commit
save
exit

```

## Install adam:ONE

Replace the `environment` values appropriate to your network as talked about above under Preparation.  
Any [time-zone supported](https://timezonedb.com/time-zones) by `set system time-zone` can be used for the value of `TZ`.  
Install adam:ONE as follows:

```bash
add container image cr.adamnet.io/adamone:latest
configure
set container name adamone image cr.adamnet.io/adamone:latest
set container name adamone environment LISTEN_ADDRESSES value '192.168.1.1,2001:db8:1:2::1'
set container name adamone environment LAN_INTERFACES value 'eth1'
set container name adamone environment LAN_IP4_SUBNETS value '192.168.1.0/24'
set container name adamone environment LAN_IP6_SUBNETS value '2001:db8:1:2::/64'
set container name adamone environment LOG_LEVEL value 4
set container name adamone environment TZ value 'Etc/UTC'
set container name adamone allow-host-networks
set container name adamone volume config destination /opt
set container name adamone volume config source /config
set container name adamone capability net-admin
set container name adamone capability net-bind-service
set container name adamone capability net-raw
set container name adamone capability sys-admin
set container name adamone memory 0
commit
save
exit

```

### Set up your Box ID

On initial run a Box ID will be automatically generated for you.  
Run the following command to show the Box ID of your installation which you can then add to  
your Dashboard at [https://dashboard.adamnet.works](https://dashboard.adamnet.works)

```bash
sudo podman exec adamone config boxid

```

Once your router shows online in the Dashboard, you should be online with adam:ONE!

## How to Upgrade adam:ONE

### Automated Upgrades

Run these commands to install an upgrade script and set to run on a schedule.  
Set the values of MM, HH and DOW to your desired hour, minute and day of week.

```bash
bash -c 'cat > /config/scripts/adamone.script' << "EOF"
#!/bin/vbash
source /opt/vyatta/etc/functions/script-template

run update container image adamone
run restart container adamone
EOF
chmod +x /config/scripts/adamone.script
configure
set system task-scheduler task adamone executable path '/config/scripts/adamone.script'
set system task-scheduler task adamone crontab-spec 'MM HH * * DOW'
commit
save

```

### Manual Upgrades

```bash
update container image adamone
restart container adamone

```

### Switching to Rapid Release

```bash
add container image cr.adamnet.io/adamone:devel
configure
set container name adamone image cr.adamnet.io/adamone:devel
commit
save
exit

```

## Optional Configuration

To use the following options, set them as environment values for the container.

#### BACKUP\_SCHEDULE\_DAY and BACKUP\_SCHEDULE\_HOUR

Set both of these options to enable automatic router config backups. Each week on the day of week specified, your router config wil be uploaded to the ADAMnetworks cloud, encrypted with AES256-GCM, and available in the Backups tab on the Dashboard.

DAY should be a day of week between 0-6 (Sunday to Saturday)

HOUR should 0-23 (24-hour time)

For example if setting to Sunday at 2am, use:

```sh
set container name adamone environment BACKUP_SCHEDULE_DAY value '0'
set container name adamone environment BACKUP_SCHEDULE_HOUR value '2'

```

### HIJACK\_DNS

Set value to `true` for a NAT rule to be auto-created forcing Classic DNS to adam:ONE on all DNS queries coming from `LAN_INTERFACES`.

```sh
set container name adamone environment HIJACK_DNS value 'true'

```

### LOG\_LEVEL

Set to a value between 0 for no logs, and 6 for debug logs.  
Default value is 4

```sh
set container name adamone environment LOG_LEVEL value '4'

```

### SYSLOG\_LEVEL

Set to a value between 0 for no logs, and 6 for debug logs.  
Default value is 4

### LOG\_FILE

Set to a path to save log files instead of going to standard output. If you modify this setting you will no longer be able to use the `monitor` command to view the log.

### IP\_ONLY\_DISCOVERY\_SUBNETS

A comma separated list of subnets where you do not want the MAC address to be used as a device identifier. This would be used for VPN traffic, or other situations where you do not have layer 2 visibility to a network.

```sh
set container name adamone environment IP_ONLY_DISCOVERY_SUBNETS value '192.0.2.0/24,198.51.100.0/24'

```

### BYPASS\_IP4\_SUBNET\_DST & BYPASS\_IP6\_SUBNET\_DST

To bypass DTTS for specific destination subnet(s), set `BYPASS_IP4_SUBNET_DST` for IPv4 and `BYPASS_IP6_SUBNET_DST` for IPv6. If you have more than one, separate them with a comma, no spaces.

### BYPASS\_IP4\_SUBNET\_SRC & BYPASS\_IP6\_SUBNET\_SRC

To bypass DTTS for specific source subnet(s), set `BYPASS_IP4_SUBNET_SRC` for IPv4 and `BYPASS_IP6_SUBNET_SRC` for IPv6. If you have more than one, separate them with a comma, no spaces.

### FALLBACK\_INTERFACE

By default the first value of `LAN_INTERFACES` will be used as the fallback HTTP interface. This allows MyTools and block pages to work on traffic from VPNs or other routed external subnets.  
You can set `FALLBACK_INTERFACE` to override the automatic default and set it to a specific interface.

## Show adam:ONE Service Logs

For normal usage, use [http://adamone.tools](http://adamone.tools) to access the MyTools Log.  
For troubleshooting issues you can also view the service logs as follows.

```bash
# Show log history
show container log adamone

# Stream log
monitor log container adamone

```
