Skip to content

Commit

Permalink
Automatic documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
igorpecovnik committed Jan 3, 2025
1 parent 0d8cd91 commit ad10290
Show file tree
Hide file tree
Showing 3 changed files with 183 additions and 0 deletions.
100 changes: 100 additions & 0 deletions docs/User-Guide_Armbian-Config/Network.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,5 +108,105 @@ armbian-config --cmd NE005



***

## WireGuard VPN client / server

<!--- section image START from tools/include/images/WG001.png --->
[![WireGuard VPN client / server](/images/WG001.png)](#)
<!--- section image STOP from tools/include/images/WG001.png --->


<!--- header START from tools/include/markdown/WG001-header.md --->
WireGuard is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. Regarded as the most secure, easiest to use, and simplest VPN solution in the industry.
<!--- header STOP from tools/include/markdown/WG001-header.md --->

**Command:**
~~~
armbian-config --cmd WG001
~~~

**Author:** @armbian

**Status:** Enabled


<!--- footer START from tools/include/markdown/WG001-footer.md --->
=== "Access to the server from internet"

Remember to open/forward the port 51820 (UDP) through NAT on your router.

=== "Directories"

- Install directory: `/armbian/wireguard`
- Site configuration directory: `/armbian/wireguard/config`

=== "View logs"

```sh
docker logs -f wireguard
```

# Install server and enable private network on a client

1. Install Wireguard server
2. It will asks you for peer keywords. It will make a profile for each peer
3. Download client to your PC, server or mobile phone. Scan OR code or copy credentials to the client.

Enjoy private network! Its that easy.

More informations:

<https://docs.linuxserver.io/images/docker-wireguard/>
<!--- footer STOP from tools/include/markdown/WG001-footer.md --->



***

## WireGuard remove
This operation will remove WireGuard

**Command:**
~~~
armbian-config --cmd WG002
~~~

**Author:** @armbian

**Status:** Enabled



***

## WireGuard clients QR codes
**Command:**
~~~
armbian-config --cmd WG003
~~~

**Author:** @armbian

**Status:** Enabled



***

## WireGuard purge with data folder
This operation will purge WireGuard with data folder

**Command:**
~~~
armbian-config --cmd WG004
~~~

**Author:** @armbian

**Status:** Enabled



***

83 changes: 83 additions & 0 deletions docs/User-Guide_Armbian-Software/Printing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Tools for printing and 3D printing


***

## OctoPrint web-based 3D printers management tool

<!--- section image START from tools/include/images/OCT001.png --->
[![OctoPrint web-based 3D printers management tool](/images/OCT001.png)](#)
<!--- section image STOP from tools/include/images/OCT001.png --->


<!--- header START from tools/include/markdown/OCT001-header.md --->
OctoPrint is an open source 3D printer controller application, which provides a web interface for the connected printers. It displays printers status and key parameters and allows user to schedule prints and remotely control the printer.
<!--- header STOP from tools/include/markdown/OCT001-header.md --->

This operation will install OctoPrint

**Command:**
~~~
armbian-config --cmd OCT001
~~~

**Author:** @armbian

**Status:** Stable


<!--- footer START from tools/include/markdown/OCT001-footer.md --->
=== "Access to the web interface"

The web interface is accessible via port **7981**:

- URL: `https://<your.IP>:7981`

=== "Directories"

- Install directory: `/armbian/octoprint`

=== "View logs"

```sh
docker logs -f octoprint
```

<!--- footer STOP from tools/include/markdown/OCT001-footer.md --->



***

## OctoPrint remove
This operation will remove OctoPrint

**Command:**
~~~
armbian-config --cmd OCT002
~~~

**Author:** @armbian

**Status:** Stable



***

## OctoPrint purge with data folder
This operation will purge OctoPrint with data folder

**Command:**
~~~
armbian-config --cmd OCT003
~~~

**Author:** @armbian

**Status:** Stable



***

Binary file added docs/images/WG001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad10290

Please sign in to comment.