public/owltide
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages 1 Wiki Activity Actions

Fix AUTH variables missing PUBLIC prefix in docs

Browse source
This commit is contained in:
Hornwitser 2025-07-09 19:26:38 +02:00
parent df64d43b38
commit 281dd1b984
3 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/admin/authentication.md
View file

@ -12,4 +12,4 @@ In order to use Telegram as an AP you need to be hosting Owltide under a domain
You will also need a bot which can be created by messaging [@BotFather](https://t.me/BotFather), with the domain of the bot set using the `/setdomain` command to the domain Owltide is hosted under. You will also need a bot which can be created by messaging [@BotFather](https://t.me/BotFather), with the domain of the bot set using the `/setdomain` command to the domain Owltide is hosted under.
Once you have the pre-requisites you need to configure `NUXT_TELEGRAM_BOT_TOKEN_FILE` to a path to a file containing the token of the bot with no spaces or new-lines. `NUXT_PUBLIC_TELEGRAM_BOT_USERNAME` to the username of the bot. And finally `NUXT_AUTH_TELEGRAM_ENABLED` to `true` to enable authentication via Telegram. Once you have the pre-requisites you need to configure `NUXT_TELEGRAM_BOT_TOKEN_FILE` to a path to a file containing the token of the bot with no spaces or new-lines. `NUXT_PUBLIC_TELEGRAM_BOT_USERNAME` to the username of the bot. And finally `NUXT_PUBLIC_AUTH_TELEGRAM_ENABLED` to `true` to enable authentication via Telegram.

8
docs/admin/config.md
View file

@ -20,7 +20,7 @@ Time in seconds before a session is deleted from the client and server, resultin
This should be several times greater that `NUXT_SESSION_ROTATES_TIMEOUT`. This should be several times greater that `NUXT_SESSION_ROTATES_TIMEOUT`.
### NUXT_AUTH_DEMO_ENABLED ### NUXT_PUBLIC_AUTH_DEMO_ENABLED
Boolean indicating if the demo authentication provider should be enabled. This allows logging in using only a name with no additional checks or security and should _never_ be enabled on a production system. The purpose of this is to make it easier to demo the system. Boolean indicating if the demo authentication provider should be enabled. This allows logging in using only a name with no additional checks or security and should _never_ be enabled on a production system. The purpose of this is to make it easier to demo the system.
@ -30,15 +30,15 @@ Defaults to `false`.
Path to a file containing the token for the Telegram bot used for authenticating users via Telegram. Path to a file containing the token for the Telegram bot used for authenticating users via Telegram.
Does nothing if `NUXT_AUTH_TELEGRAM_ENABLED` is not enabled. Does nothing if `NUXT_PUBLIC_AUTH_TELEGRAM_ENABLED` is not enabled.
### NUXT_PUBLIC_TELEGRAM_BOT_USERNAME ### NUXT_PUBLIC_TELEGRAM_BOT_USERNAME
Username of the Telegram bot used for authenticating users via Telegram. Username of the Telegram bot used for authenticating users via Telegram.
Does nothing if `NUXT_AUTH_TELEGRAM_ENABLED` is not enabled. Does nothing if `NUXT_PUBLIC_AUTH_TELEGRAM_ENABLED` is not enabled.
### NUXT_AUTH_TELEGRAM_ENABLED ### NUXT_PUBLIC_AUTH_TELEGRAM_ENABLED
Boolean indicating if authentication via Telegram is enabled or not. Requires `NUXT_PUBLIC_TELEGRAM_BOT_USERNAME` and `NUXT_TELEGRAM_BOT_TOKEN_FILE` to be set in order to work. Boolean indicating if authentication via Telegram is enabled or not. Requires `NUXT_PUBLIC_TELEGRAM_BOT_USERNAME` and `NUXT_TELEGRAM_BOT_TOKEN_FILE` to be set in order to work.

11
tools/tag-release.sh Executable file
View file

@ -0,0 +1,11 @@
#!/bin/bash
# Finds the next available r<year>.<month>.<increment> identifier
YEAR_MONTH=$(date -u +%Y.%-m)
YEAR=${YEAR_MONTH:0:4}
MONTH=${YEAR_MONTH:5}
LAST_INCREMENT=$(git tag --list | grep '^r[1-9][0-9]*\.\([1-9]\|1[0-2]\)\.\(0\|[1-9][0-9]*\)$' | cut -d . -f 3 | sort -nr | head -n 1)
RELEASE=r${YEAR_MONTH}.$(( ${LAST_INCREMENT:--1} + 1 ))
git tag $RELEASE
echo Tagged $RELEASE