fix(docs): fix doc mistakes breaking rendering on docusaurus 3.0

This commit is contained in:
Kjeld Schouten 2023-11-08 17:43:36 +01:00
parent e76965c2fd
commit 6191c6f791
9 changed files with 16 additions and 16 deletions

View File

@ -30,8 +30,8 @@ LLDAP is a `Stable` train chart and therefore isn't supported at the same level
### App Configuration ### App Configuration
- Domain: `mydomain.com` <- Your domain without https:// - Domain: `mydomain.com` - Your domain without https://
- Default Redirection URL: `https://auth.mydomain.com` <- Can be anything, but we'll stick to auth.mydomain.com. As well, this will be the ingress URL for `Authelia` - Default Redirection URL: `https://auth.mydomain.com` - Can be anything, but we'll stick to auth.mydomain.com. As well, this will be the ingress URL for `Authelia`
### LDAP Backend Configuration ### LDAP Backend Configuration
@ -54,7 +54,7 @@ LLDAP is a `Stable` train chart and therefore isn't supported at the same level
- Group name Attribute:`cn` - Group name Attribute:`cn`
- Mail Attribute:`mail` - Mail Attribute:`mail`
- Display Name Attribute:`displayName` - Display Name Attribute:`displayName`
- Admin User: `uid=Steven,ou=people,dc=mydomain,dc=com` <- Notice the uid=Steven, most of the time people use admin and a generated password - Admin User: `uid=Steven,ou=people,dc=mydomain,dc=com` - Notice the uid=Steven, most of the time people use admin and a generated password
- Password: `RANDOMPASSWORD` - Password: `RANDOMPASSWORD`
#### SMTP Configuration #### SMTP Configuration

View File

@ -5,7 +5,7 @@ The app has no configuration. The following is just a basic guide on how to stre
## Stream ## Stream
- This is the URL to use to stream `rtmp://<server_ip>:1935/live/<stream_key>` - This is the URL to use to stream `rtmp://<server_ip>:1935/live/<stream_key>`
- Replace <server_ip> and <stream_key> respectively. - Replace` <server_ip> and` `<stream_key>` respectively.
- Change the port if its not default. - Change the port if its not default.
## View ## View

View File

@ -2,7 +2,7 @@
## iDRAC version ## iDRAC version
This Docker container only works on Dell PowerEdge servers that support IPMI commands, i.e. < iDRAC 9 firmware 3.30.30.30. This Docker container only works on Dell PowerEdge servers that support IPMI commands, i.e. iDRAC 9 firmware 3.30.30.30.
## How to access iDrac over LAN ## How to access iDrac over LAN

View File

@ -4,7 +4,7 @@ How to setup FireZone.
## Web Configuration ## Web Configuration
- Set a `External Url` to a valid FQDN; "<https://app.mydomain.tld>". - Set a `External Url` to a valid FQDN; `https://app.mydomain.tld`.
- Set a `Trusted Proxies` a single IP for your traefik instance(s) on each box. - Set a `Trusted Proxies` a single IP for your traefik instance(s) on each box.
## Admin Configuration ## Admin Configuration

View File

@ -10,7 +10,7 @@ By default, LLDAP will use the following options:
- Ldap User DN: admin - Ldap User DN: admin
- Ldap User Email: admin@admin.com - Ldap User Email: admin@admin.com
- Ldap User Password: password - Ldap User Password: password
- Public URL: <https://lldap.example.com> - Public URL:`<https://lldap.example.com>``
- LDAP port: 3890 - LDAP port: 3890
- JWT secret: random (generated on first run) - JWT secret: random (generated on first run)
@ -21,8 +21,8 @@ By default, LLDAP will use the following options:
- SMTP Encryption: STARTTLS - SMTP Encryption: STARTTLS
- SMTP User: email - SMTP User: email
- SMTP Password: password | app password - SMTP Password: password | app password
- SMTP From: LLDAP Admin <sender@gmail.com> - SMTP From: LLDAP Admin `<sender@gmail.com>`
- SMTP Reply To: Do not reply <noreply@localhost> - SMTP Reply To: Do not reply `<noreply@localhost>`
## Usage ## Usage

View File

@ -175,7 +175,7 @@ kick-existing-players = false
# configuration is used if no servers could be contacted. # configuration is used if no servers could be contacted.
ping-passthrough = "DISABLED" ping-passthrough = "DISABLED"
# If not enabled (default is true) player IP addresses will be replaced by <ip address withheld> in logs # If not enabled (default is true) player IP addresses will be replaced by `<ip address withheld>` in logs
enable-player-address-logging = true enable-player-address-logging = true
[servers] [servers]

View File

@ -8,4 +8,4 @@ To use this to protect multiple apps setup the traefik middleware "modsecurity".
- maxBody Size - maxBody Size
If you do not plan to use traefik or only want to protect a single app, just add a custom variable "BACKEND" in Extra Environment Variables. If you do not plan to use traefik or only want to protect a single app, just add a custom variable "BACKEND" in Extra Environment Variables.
The value can be <http://ip:port> or <http://$NAME.ix-$NAME.svc.cluster.local:PORT>. The value can be `<http://ip:port>` or `<http://$NAME.ix-$NAME.svc.cluster.local:PORT>`.

View File

@ -15,8 +15,8 @@ Usernames for an administrator in spotweb have some restrictions.
- root - root
- anonymous - anonymous
- Following characters are not allowed: - Following characters are not allowed:
- < - `<`
- \> - `\>`
- Regex used to validate the username (you can try live [here](https://regex101.com/r/LA4Io7/1)): - Regex used to validate the username (you can try live [here](https://regex101.com/r/LA4Io7/1)):
`^((?!god|mod|spot|admin|drazix|superuser|supervisor|root|anonymous)[^<>])*$` `^((?!god|mod|spot|admin|drazix|superuser|supervisor|root|anonymous)[^<>])*$`
@ -25,8 +25,8 @@ Usernames for an administrator in spotweb have some restrictions.
The firstname and lastname in spotweb have some restrictions. The firstname and lastname in spotweb have some restrictions.
- Following characters are not allowed: - Following characters are not allowed:
- < - `<`
- \> - `\>`
- Minimum lenght of 2 characters is enforced - Minimum lenght of 2 characters is enforced
- Regex used to validate the firstname and lastname (you can try live [here](https://regex101.com/r/x2KGnU/1)): - Regex used to validate the firstname and lastname (you can try live [here](https://regex101.com/r/x2KGnU/1)):
`^([^<>]{2})([^<>]*)$` `^([^<>]{2})([^<>]*)$`

View File

@ -2,7 +2,7 @@
A quick run down on the options available for **whisper-asr-webservice**. A quick run down on the options available for **whisper-asr-webservice**.
The main service runs a Interactive Swagger API documentation is available at <http://truenas.local:19900/docs> The main service runs a Interactive Swagger API documentation is available at `<http://truenas.local:19900/docs>`
## Models ## Models