Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/twofactor_gateway.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristoph Wurst <christoph@winzerhof-wurst.at>2018-08-22 09:27:13 +0300
committerChristoph Wurst <christoph@winzerhof-wurst.at>2018-08-22 09:27:13 +0300
commit2fc2e7f51a99474d31bcae4bb5ed19eb79dbeea8 (patch)
tree5d6b29988301d5283ba3dd0df51fec3397f66695
parente023eb7f5fa0a1eb3f2ec644340ace630a6d488a (diff)
Update docs to use interactive CLI
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
-rw-r--r--doc/admin/README.md29
1 files changed, 8 insertions, 21 deletions
diff --git a/doc/admin/README.md b/doc/admin/README.md
index db35950..c8c6ae6 100644
--- a/doc/admin/README.md
+++ b/doc/admin/README.md
@@ -10,21 +10,18 @@ Stability: Experimental
Use the Webservices provided by playSMS for sending SMS.
-Admin configuration:
+Interactive admin configuration:
```bash
-./occ config:app:set twofactor_gateway sms_provider --value "playsms"
-./occ config:app:set twofactor_gateway playsms_url --value "playsmswebservicesurl"
-./occ config:app:set twofactor_gateway playsms_user --value "yourusername"
-./occ config:app:set twofactor_gateway playsms_password --value "yourpassword"
+occ twofactorauth:gateway:configure sms
```
### Signal
Url: https://www.signal.org/
Stability: Experimental
-Admin configuration:
+Interactive admin configuration:
```bash
-./occ config:app:set twofactor_gateway sms_provider --value "signal"
+occ twofactorauth:gateway:configure signal
```
### Telegram
@@ -33,26 +30,16 @@ Stability: Unstable
Uses Telegram messages for sending a 2FA code
-Admin configuration:
+Interactive admin configuration:
```bash
-./occ config:app:set twofactor_gateway sms_provider --value "telegram"
-./occ config:app:set twofactor_gateway telegram_bot_token --value "your telegram bot api token"
-./occ config:app:set twofactor_gateway telegram_url --value "https://api.telegram.org/bot"
+occ twofactorauth:gateway:configure telegram
```
-Specific entries in `oc_preferences`:
-- userid: your Nextcloud user UID
-- appid: ``twofactor_gateway``
-- configkey: ``telegram_id``
-- configvalue: your telegram id. You can get your telegram id by searching the user <b>What's my Telegram ID?</b> in Telegram and start the conversation.
-
### websms.de
Url: https://websms.de/
Stability: Stable
-Admin configuration:
+Interactive admin configuration:
```bash
-./occ config:app:set twofactor_gateway sms_provider --value "websms.de"
-./occ config:app:set twofactor_gateway websms_de_user --value "yourusername"
-./occ config:app:set twofactor_gateway websms_de_password --value "yourpassword"
+occ twofactorauth:gateway:configure sms
```