~fkooman/vpn-documentation

cb2054472c437e809cdecd368987c55c302e4cac — Fran├žois Kooman 1 year, 2 months ago 1bb9150 codeberg
update all links from GitHub to Codeberg if necessary

fix list indent
M CONTRIBUTE_TRANSLATIONS.md => CONTRIBUTE_TRANSLATIONS.md +3 -3
@@ 8,10 8,10 @@ explains how.
You can check which translations are already available, and possibly update 
them if they are out of date:

* [vpn-user-portal](https://github.com/eduvpn/vpn-user-portal/tree/v3/locale)
* [vpn-user-portal](https://git.sr.ht/~fkooman/vpn-user-portal/tree/v3/item/locale)

If you want to contribute a new translation you can take the 
[empty](https://github.com/eduvpn/vpn-user-portal/blob/v3/locale/empty.php) 
[empty](https://git.sr.ht/~fkooman/vpn-user-portal/tree/v3/item/locale/empty.php) 
file and translate all strings in there and send it.

Also please update `src/Tpl.php` under the `supportedLanguages()` function, 


@@ 36,6 36,6 @@ Once you are done, you can submit your translation file either by creating a
"Pull Request" on GitHub, or simply mailing the file with your translations to
[eduvpn-support@lists.geant.org](mailto:eduvpn-support@lists.geant.org). Don't
forget to mention how/if you want to be 
[credited](https://github.com/eduvpn/vpn-user-portal/blob/v3/locale/CREDITS.md).
[credited](https://git.sr.ht/~fkooman/vpn-user-portal/tree/v3/item/locale/CREDITS.md).

Thanks!

M CUSTOM_BRANDING.md => CUSTOM_BRANDING.md +2 -2
@@ 73,8 73,8 @@ This will then try to find the CSS file at
We have two officially supported themes, you can find the relevant files here 
and get inspiration:

* [eduVPN](https://github.com/eduvpn/vpn-portal-artwork/)
* [Let's Connect!](https://github.com/letsconnectvpn/vpn-portal-artwork/)
* [eduVPN](https://git.sr.ht/~fkooman/vpn-portal-artwork-eduVPN)
* [Let's Connect!](https://git.sr.ht/~fkooman/vpn-portal-artwork-LC)

See [BRANDING](BRANDING.md) if you want to use those instead of creating your
own.

M DEPLOY_DEBIAN.md => DEPLOY_DEBIAN.md +2 -2
@@ 35,9 35,9 @@ installation the VPN deployment MAY not work...
Perform these steps on the host where you want to deploy:

    $ sudo apt -y install ca-certificates wget
    $ wget https://github.com/eduvpn/documentation/archive/v3.tar.gz
    $ wget https://codeberg.org/eduVPN/documentation/archive/v3.tar.gz
    $ tar -xzf v3.tar.gz
    $ cd documentation-3
    $ cd documentation

We assume you have `sudo` installed and configured for your user first, after
this:

M DEPLOY_EL.md => DEPLOY_EL.md +2 -2
@@ 40,9 40,9 @@ not have `tar`:

Perform these steps on the host where you want to deploy:

    $ curl -L -O https://github.com/eduvpn/documentation/archive/v3.tar.gz
    $ curl -L -O https://codeberg.org/eduVPN/documentation/archive/v3.tar.gz
    $ tar -xzf v3.tar.gz
    $ cd documentation-3
    $ cd documentation

Run the script (as root):


M DEPLOY_FEDORA.md => DEPLOY_FEDORA.md +2 -2
@@ 40,9 40,9 @@ not have `tar`:

Perform these steps on the host where you want to deploy:

    $ curl -L -O https://github.com/eduvpn/documentation/archive/v3.tar.gz
    $ curl -L -O https://codeberg.org/eduVPN/documentation/archive/v3.tar.gz
    $ tar -xzf v3.tar.gz
    $ cd documentation-3
    $ cd documentation

Run the script (as root):


M FROM_2_TO_3.md => FROM_2_TO_3.md +5 -5
@@ 14,8 14,8 @@ manually got through the portal once the upgrade is complete.
You MUST be running the server on Debian 11, if you are not running on Debian 
11, but on a previous version of Debian, follow the instructions here first:

* [Debian 9 to Debian 10](https://github.com/eduvpn/documentation/blob/v2/UPGRADE_DEBIAN_9_TO_10.md);
* [Debian 10 to Debian 11](https://github.com/eduvpn/documentation/blob/v2/UPGRADE_DEBIAN_10_TO_11.md)
* [Debian 9 to Debian 10](https://codeberg.org/eduVPN/documentation/src/branch/v2/UPGRADE_DEBIAN_9_TO_10.md);
* [Debian 10 to Debian 11](https://codeberg.org/eduVPN/documentation/src/branch/v2/UPGRADE_DEBIAN_10_TO_11.md)

You probably have to go first from Debian 9 to 10 and then to 11 if you are 
still running Debian 9. If you try to go in 1 step, be extra careful and read


@@ 110,11 110,11 @@ contain secrets.
#### Profile Configuration

You can also compare the "Profile Configuration" documentation for 
[2.x](https://github.com/eduvpn/documentation/blob/v2/PROFILE_CONFIG.md) and 
[3.x](https://github.com/eduvpn/documentation/blob/v3/PROFILE_CONFIG.md) in 
[2.x](https://codeberg.org/eduVPN/documentation/src/branch/v2/PROFILE_CONFIG.md) and 
[3.x](https://codeberg.org/eduVPN/documentation/src/branch/v3/PROFILE_CONFIG.md) in 
case you want to clarify some of the options. For completeness sake, there is 
also a 
[list](https://github.com/eduvpn/vpn-server-api/blob/v2/CONFIG_CHANGES.md) of 
[list](https://git.sr.ht/~fkooman/vpn-server-api/tree/v2/item/CONFIG_CHANGES.md) of 
configuration changes for the 2.x server since the release of 2.0.0.

In 3.x the `vpnProfiles` key has been renamed to `ProfileList`. The `profileId`

M MULTI_NODE.md => MULTI_NODE.md +2 -2
@@ 45,9 45,9 @@ We will use NAT for IPv4 and IPv6 client traffic.
Perform these steps on the hosts:

```bash
$ curl -L -O https://github.com/eduvpn/documentation/archive/v3.tar.gz
$ curl -L -O https://codeberg.org/eduVPN/documentation/archive/v3.tar.gz
$ tar -xzf v3.tar.gz
$ cd documentation-3
$ cd documentation
```

## Controller

M README.md => README.md +5 -5
@@ 19,11 19,11 @@ contact us at

## Supported Versions

| Version                                              | Release Date | OS Support                                                   |  EOL*      |
| ---------------------------------------------------- | ------------ | ------------------------------------------------------------ | ---------- |
| [3](https://github.com/eduvpn/documentation/tree/v3) | 2022-05-25   | Debian (>= 11), Ubuntu (>= 22.04), Fedora (>= 36), EL (>= 9) | TBD        |
| [2](https://github.com/eduvpn/documentation/tree/v2) | 2019-04-02   | Debian (>= 10), CentOS 7, Fedora (>= 35)                     | 2024-06-30 |
| [1](https://github.com/eduvpn/documentation/tree/v1) | 2017-07-13   | _N/A_                                                        | _N/A_      |
| Version                                                      | Release Date | OS Support                                                   |  EOL*      |
| ------------------------------------------------------------ | ------------ | ------------------------------------------------------------ | ---------- |
| [3](https://codeberg.org/eduVPN/documentation/src/branch/v3) | 2022-05-25   | Debian (>= 11), Ubuntu (>= 22.04), Fedora (>= 36), EL (>= 9) | TBD        |
| [2](https://codeberg.org/eduVPN/documentation/src/branch/v2) | 2019-04-02   | Debian (>= 10), CentOS 7, Fedora (>= 35)                     | 2024-06-30 |
| [1](https://codeberg.org/eduVPN/documentation/src/branch/v1) | 2017-07-13   | _N/A_                                                        | _N/A_      |

We support a release until such time the EOL date has been reached or none of 
the eduVPN servers we officially [support](https://status.eduvpn.org/) are 

M SCALING.md => SCALING.md +4 -6
@@ 123,12 123,10 @@ remote vpn.example 1200 tcp
Because every configuration download will result in another (random) selection
of ports, the load will eventually be distributed among the various processes.

Starting from release 2.1.1 of 
[vpn-user-portal](https://github.com/eduvpn/vpn-user-portal) the following way
of dealing with "special" ports is implemented, assuming they are used. Special 
ports are always added at the end of the configuration files, below the 
"remote" lines as mentioned above. By special ports the following ports and 
protocols are meant:
Starting from release 2.1.1 of vpn-user-portal the following way of dealing 
with "special" ports is implemented, assuming they are used. Special ports are 
always added at the end of the configuration files, below the "remote" lines as 
mentioned above. By special ports the following ports and protocols are meant:

* `udp/53`
* `udp/443`

M SECURITY.md => SECURITY.md +2 -2
@@ 10,7 10,7 @@ By default [Apache](https://httpd.apache.org/) is used.
### Debian

We use a 
[template](https://github.com/eduvpn/documentation/blob/v3/resources/ssl.debian.conf) 
[template](https://codeberg.org/eduVPN/documentation/src/branch/v3/resources/ssl.debian.conf) 
to update the TLS options.

### Fedora


@@ 18,7 18,7 @@ to update the TLS options.
TBD. Look into "Crypto Policies" on Fedora/CentOS.

We use a 
[template](https://github.com/eduvpn/documentation/blob/v3/resources/ssl.fedora.conf) 
[template](https://codeberg.org/eduVPN/documentation/src/branch/v3/resources/ssl.fedora.conf) 
to update the TLS options.

## OpenVPN