Verified Commit 8e8f3502 authored by Lukas Jelinek's avatar Lukas Jelinek

Unify format of file names (hyphens instead of underscores)

parent 9f7312d4
Pipeline #73769 passed with stages
in 1 minute and 48 seconds
......@@ -27,7 +27,7 @@ To use Netmetr on Turris device proceed in these steps:
Netmetr could be also started automatically to periodically benchmark you Internet
connection. You can use a timetable to choose hours to run it.
When autostarted, Netmetr is not started in the exact times stated above, instead
it uses a few minute random wait to load balance the server.
# OpenVPN client on Turris
Starting with [Turris OS 5.1](../../,
Starting with [Turris OS 5.1](../../,
you can configure the OpenVPN client through the reForis web interface.
## What is OpenVPN?
......@@ -165,7 +165,7 @@ You don't have to set a proper static lease to see names in PaKon - just fill
in the name and select MAC address. If you fill in also the IP address, you
create a static lease - meaning that the device will always get the same IP
address. For more details about static leases click
![Screenshot - LuCI Static lease](static-lease.png)
......@@ -11,8 +11,8 @@ before you start experimenting. We have a tool called
will find an examples how to use it to create a snapshot.
To be able get back to your router, the easiest way to do so is to use
rescue mode (on [Turris Omnia](../hw/omnia/ or
[MOX](../hw/mox/ to get to the earlier snapshot or to do a
rescue mode (on [Turris Omnia](../hw/omnia/ or
[MOX](../hw/mox/ to get to the earlier snapshot or to do a
factory reset. In both cases your current state is saved as another snapshot so
you can still mount it and explore the changes you made later.
......@@ -92,12 +92,12 @@ settings that could influence it.
The easiest way to fix it is to either revert to some previous and still working
snapshot by using [Schnapps](../geek/schnapps/ or to do a complete
Factory reset using rescue mode on both Turris
[Omnia](../hw/omnia/ and Turris
[Omnia](../hw/omnia/ and Turris
#### Misconfigured WAN
Double check your WAN settings in [Foris](foris/wan/ to make sure
Double check your WAN settings in [Foris](foris/wan/ to make sure
it corresponds the recommended settings from your ISP and do WAN test from
within the Foris.
......@@ -109,8 +109,8 @@ flashing your router with the latest medkit (and setting just bare minimum from
the scratch) to avoid any misconfiguration.
You can do so by using rescue mode on both Turris
[Omnia](../hw/omnia/ and Turris
[Omnia](../hw/omnia/ and Turris
If it doesn't help, contact our [support]( and provide us with
diagnostics, which can provide us leads, where the issue might be. This is only
......@@ -130,4 +130,4 @@ _Updater_ tab in Foris. Last but not least, booting over the network works
only via the Ethernet connector on MOX A and after the first boot, only with
the router it is paired with. Pairing is lost on factory reset of controlling
router. To make sure your MOX is not paired with already, use [Factory
......@@ -21,7 +21,7 @@ change the purpose of your only Ethernet port.
You shouldn't connect your MOX A directly to the internet.
![Mox without internet](mox_no_internet.png)
![Mox without internet](mox-no-internet.png)
You can connect your MOX A directly to your computer, but your MOX A wouldn't be
able to connect to the internet during the first setup and download any
......@@ -29,20 +29,20 @@ updates, which is not recommended. Some steps in the configuration guide (like
checking the internet connection) could fail because of that, but it should be
usually OK.
![Mox connected directly to computer](mox_to_internet.png)
![Mox connected directly to computer](mox-to-internet.png)
If you have a working local network with dhcp behind a firewall and you can
somehow list IP addresses of newly connected devices, it is recommended to use
it for MOX A configuration. In this setup, your MOX A will be able to connect
to your computer as well as connect to the internet.
![Ideal connection of MOX](mox_cpu_only.png)
![Ideal connection of MOX](mox-cpu-only.png)
## Installation steps
### Before you start
{! basics/first-setup/ !}
{! basics/first-setup/ !}
### Setup
......@@ -5,7 +5,7 @@ board: mox
## Before you start
{! basics/first-setup/ !}
{! basics/first-setup/ !}
## Connecting cables
......@@ -27,7 +27,7 @@ afterwards.
### One Ethernet port device
The trickiest case is if you have **only one Ethernet port**. Therefore we
created a [special guide]( for the case with just one Ethernet
created a [special guide]( for the case with just one Ethernet
port such as MOX Start, MOX Pocket Wi-Fi or MOX Power Wi-Fi.
## Entering guide
......@@ -8,7 +8,7 @@ board: shield
Turris shield has Ethernet ports split into two groups — WAN (Wide Area Network
aka Internet) and LAN (Local Area Network aka your private network to be secured).
![Turris Shield ports](shield_ports.png)
![Turris Shield ports](shield-ports.png)
There is only one WAN port — the grey one, but you have four LAN ports
available — the ones framed in blue.
......@@ -42,7 +42,7 @@ password. That is the only mandatory step in the initial Guide.
### Step one — password settings
![Setting password](shield_pass.png)
![Setting password](shield-pass.png)
As mentioned previously, you are asked to enter password that will protect your
administration interface. Pick something that is not easy to guess and long
......@@ -50,7 +50,7 @@ enough.
#### Step one A — Insecure password used
![Invalid password](shield_pass_invalid.png)
![Invalid password](shield-pass-invalid.png)
While setting the password, password is checked offline against set of well-known
passwords that we captured in our honeypots. If you see the error above, the
......@@ -58,14 +58,14 @@ password you picked is definitely not secure and you should pick something else.
#### Step one B — Password set
![Password set](shield_pass_set.png)
![Password set](shield-pass-set.png)
Once you choose non-blacklisted password that is long enough, it is set, and
you may proceed to the next step via _Next step_ button.
## Step two — guide finished
![Finished guide](shield_finished.png)
![Finished guide](shield-finished.png)
Second step is farewell message from the guide. Click on _Continue_ button and
you are done. Your internet should start working and you should land on the
......@@ -33,7 +33,7 @@ through the rest of the setup.
!!! tip
On Turris Omnia, you can download the latest [medkit]( and [flash your router
via USB](../../hw/omnia/ and therefore
via USB](../../hw/omnia/ and therefore
significantly decrease update time.
After your router is fully set up you can start setting up additional services.
......@@ -28,5 +28,5 @@ and network configuration tool.
Although, there is a set of advanced administration requirements which are only possible to get done with LuCI. Such as
- [static IP addresses assignment](static_dhcp/
- [VLAN configuration](vlan/
- [static IP addresses assignment](static-dhcp/
- [VLAN configuration](vlan/
......@@ -9,12 +9,12 @@ permanent IP address.
Log in to [LuCI](../, then choose _DHCP and DNS_ in top navigation menu.
![Screenshot 1](screenshot_1.png)
![Screenshot 1](screenshot-1.png)
You can see the list of the currently connected devices, which had assigned IP addresses from DHCP server, on the bottom
of the page. Then click the _Add_ button under that list.
![Screenshot 1](screenshot_2.png)
![Screenshot 1](screenshot-2.png)
Fill the new row with:
......@@ -24,7 +24,7 @@ devices or filled manually by selecting the *\-\-custom\-\-* option.
* _IPv4-Address_ - An IP address to be permanently assigned to a device identified by MAC address. It can be select
from the list of last used IP addresses or filled manually by selecting the *\-\-custom\-\-* option.
![Screenshot 1](screenshot_3.png)
![Screenshot 1](screenshot-3.png)
You can add more devices by clicking _Add_ button. If you are done, please don't forget to press _Save & Apply_ button.
......@@ -37,7 +37,7 @@ Turris 1.0/1.1[^6].
The VLAN interfaces are configured in the _**Network > Interfaces**_ menu.
![Interface setup](luci_interface_menu.png)
![Interface setup](luci-interface-menu.png)
A VLAN tagged interface can be added to an existing or new network interface bridge
in the format `<if>.X` where **`<if>`** is the desired interface (i.e. `lan0`,
......@@ -50,21 +50,21 @@ in the format `<if>.X` where **`<if>`** is the desired interface (i.e. `lan0`,
!!! Example
Adding an interface on the port 1 of VLAN ID 12
![Adding VLAN interface](luci_adding_vlan_interface.png)
![Adding VLAN interface](luci-adding-vlan-interface.png)
#### New interface
When creating a new interface with a VLAN tagged interface, you can add the interfaces
in the window, that is shown when creating the interface.
![New interface](luci_new_interface.png)
![New interface](luci-new-interface.png)
#### Existing interface
In an existing network interface you have to edit the interface. Then select
the **Physical Settings** tab. In the opened tab add the VLAN tagged interfaces.
![Existing interface](luci_existing_interface.png)
![Existing interface](luci-existing-interface.png)
## References
......@@ -10,112 +10,112 @@ board: shield, mox, omnia, 1.x
## Router overview
![Router overview](101_reforis_overview.png)
![Router overview](101-reforis-overview.png)
## WiFi configuration
![WiFi configuration](102_reforis_wifi.png)
![WiFi configuration](102-reforis-wifi.png)
## WAN configuration
![WAN configuration](103_reforis_wan.png)
![WAN configuration](103-reforis-wan.png)
## LAN configuration
![LAN configuration](104_reforis_lan.png)
![LAN configuration](104-reforis-lan.png)
## DNS configuration
![DNS configuration](105_reforis_dns.png)
![DNS configuration](105-reforis-dns.png)
## Interface assignement
![Interface assignement](106_reforis_interfaces.png)
![Interface assignement](106-reforis-interfaces.png)
## Guest network configuration
![Guest network configuration](107_reforis_guest.png)
![Guest network configuration](107-reforis-guest.png)
## Password management
![Password management](108_reforis_password.png)
![Password management](108-reforis-password.png)
## Region and time settings
![Region and time settings](109_reforis_time.png)
![Region and time settings](109-reforis-time.png)
## Notifications configuration
![Notifications configuration](110_reforis_notification.png)
![Notifications configuration](110-reforis-notification.png)
## Reboot button page
![Reboot button page](111_reforis_reboot.png)
![Reboot button page](111-reforis-reboot.png)
## Snapshots management
![Snapshots management](112_reforis_snapshots.png)
![Snapshots management](112-reforis-snapshots.png)
## Diagnostics generator
![Diagnostics generator](113_reforis_diag.png)
![Diagnostics generator](113-reforis-diag.png)
## Updates configuration
![Updates configuration](114_reforis_updates_settings.png)
![Updates configuration](114-reforis-updates-settings.png)
## Manual update trigger
![Manual update trigger](115_reforis_updates.png)
![Manual update trigger](115-reforis-updates.png)
## Packages selection
![Packages selection](116_reforis_packages.png)
![Packages selection](116-reforis-packages.png)
## Language selection
![Language selection](117_reforis_languages.png)
![Language selection](117-reforis-languages.png)
## Speed test results
![Speed test results](118_reforis_speedtest.png)
![Speed test results](118-reforis-speedtest.png)
## Speed test configuration
![Speed test configuration](119_reforis_auto_speed_test.png)
![Speed test configuration](119-reforis-auto-speed-test.png)
## VPN server configuration
![VPN server configuration](120_reforis_vpn_server.png)
![VPN server configuration](120-reforis-vpn-server.png)
## Management of clients for VPN server
![Management of clients for VPN server](121_reforis_vpn_client_reg.png)
![Management of clients for VPN server](121-reforis-vpn-client-reg.png)
## VPN client configuration
![VPN client configuration](122_reforis_vpn_client.png)
![VPN client configuration](122-reforis-vpn-client.png)
## Remote access configuration
![Remote access configuration](123_reforis_remote_access.png)
![Remote access configuration](123-reforis-remote-access.png)
## Management of tokens for remote access
![Management of tokens for remote access](124_reforis_remote_tokens.png)
![Management of tokens for remote access](124-reforis-remote-tokens.png)
## Management of remotelly managed devices
![Management of remotelly managed devices](125_reforis_remote_devices.png)
![Management of remotelly managed devices](125-reforis-remote-devices.png)
## Netboot configuration
![Netboot configuration](126_reforis_netboot.png)
![Netboot configuration](126-reforis-netboot.png)
## Data collection settings
![Data collection settings](127_reforis_data_collect.png)
![Data collection settings](127-reforis-data-collect.png)
## About page
![About page](128_reforis_about.png)
![About page](128-reforis-about.png)
......@@ -87,7 +87,7 @@ Turris declaration that _We believe in open-source_ is not just empty statement,
we really believe in open-source. You can modify code and submit it back. This is
power of open-source. Together we can make Turris the best device there is.
Please read [guide on how to submit pull request]( and
Please read [guide on how to submit pull request]( and
[Turris project coding style](
!!! tip
......@@ -47,24 +47,24 @@ it up. You will be asked to reboot your router, so do so.
The next step is to enable Nextcloud in _Updater_ tab. After doing so, your
router will install all necessary packages.
![Nextcloud option in updater tab](nextcloud_updater.png)
![Nextcloud option in updater tab](nextcloud-updater.png)
The last step is to go back to the _Storage_ tab and after installation
finishes, you will be presented with a dialog to set your admin username and
password. If you install Nextcloud first - without setting up your external
drive - Foris wouldn't allow you to setup Nextcloud till you do so.
![Setting up a disk with Nextcloud installed](storage_plugin_nextcloud.png)
![Setting up a disk with Nextcloud installed](storage-plugin-nextcloud.png)
If you get the setup dialog, you can enter your desired credentials and you
are done. Foris will finish your Nextcloud setup. This can take a while
depending on speed of your drive.
![Nextcloud configuration](nextcloud_setup.png)
![Nextcloud configuration](nextcloud-setup.png)
Once done, you get a link directly to your ready to use Nextcloud instance.
![Nextcloud installed](nextcloud_installed.png)
![Nextcloud installed](nextcloud-installed.png)
### Manual installation from CLI
......@@ -82,7 +82,7 @@ Considerations for advanced users:
!!! tip
It is always an option to perform factory reset to recover the router if
migration fails. In case of Turris Omnia even
[rollback](../hw/omnia/ should be good enough.
[rollback](../hw/omnia/ should be good enough.
## Optional migration
Migration is not yet executed automatically but it can be triggered manually.
......@@ -101,7 +101,7 @@ To initialize migration process you have to navigate to _Updater_ tab in Foris w
interface. There you have to select package list _Migration to Turris OS 5.x_ and
save that by clicking on _Save and update_ button.
![Migration to Turris OS 5.x trigger](tos3_migration_trigger.png)
![Migration to Turris OS 5.x trigger](tos3-migration-trigger.png)
Next you have to approve installation of `tos3to4` package if you have approvals
enabled. Migration starts immediately if you don't.
\ No newline at end of file
\ No newline at end of file
\ No newline at end of file
\ No newline at end of file
\ No newline at end of file