Ver Fonte

Rearrange

Manav Rathi há 1 ano atrás
pai
commit
03c875a8b8

+ 1 - 1
docs/docs/.vitepress/sidebar.ts

@@ -94,7 +94,7 @@ export const sidebar = [
                 items: [
                     { text: "Introduction", link: "/self-hosting/guides/" },
                     {
-                        text: "Configure custom server",
+                        text: "Connect to custom server",
                         link: "/self-hosting/guides/custom-server/",
                     },
                     {

+ 14 - 10
docs/docs/auth/migration-guides/authy/index.md

@@ -7,9 +7,11 @@ description: Guide for importing your existing Authy 2FA tokens into Ente Auth
 
 A guide written by Green, an ente.io lover
 
-> [!WARNING] Authy will soon be dropping support for its desktop apps in the
-> near future. If you are looking to switch to ente Authenticator from Authy, I
-> heavily recommend you export your codes as soon as you can.
+> [!WARNING]
+>
+> Authy will soon be dropping support for its desktop apps in the near future.
+> If you are looking to switch to ente Authenticator from Authy, I heavily
+> recommend you export your codes as soon as you can.
 
 ---
 
@@ -19,8 +21,10 @@ for your new 2FA authenticator. However, easier ways exist to export your codes
 out of Authy. This guide will cover two of the most used methods for mograting
 from Authy to ente Authenticator.
 
-> [!CAUTION] Under any circumstances, do **NOT** share any JSON and TXT files
-> generated using this guide, as they contain your **unencrypted** TOTP secrets!
+> [!CAUTION]
+>
+> Under any circumstances, do **NOT** share any JSON and TXT files generated
+> using this guide, as they contain your **unencrypted** TOTP secrets!
 >
 > Also, there is **NO GUARANTEE** that these methods will export ALL of your
 > codes. Make sure that all your accounts have been imported successfully before
@@ -28,7 +32,7 @@ from Authy to ente Authenticator.
 
 ---
 
-# Method 1: Use Neeraj's export tool
+## Method 1: Use Neeraj's export tool
 
 **Who should use this?** General users who want to save time by skipping the
 hard (and rather technical) parts of the process.<br><br>
@@ -69,7 +73,7 @@ This will generate a text file called `authy_codes.txt`, which contains your
 Authy codes in ente's plaintext export format. You can now import this to ente
 Authenticator!
 
-# Method 2: Use gboudreau's GitHub guide
+## Method 2: Use gboudreau's GitHub guide
 
 **Who should use this?** Power users who have spare time on their hands and
 prefer a more "known and established" solution to exporting Authy codes.<br><br>
@@ -85,7 +89,7 @@ This will create a JSON file called `authy-to-bitwarden-export.json`, which
 contains your Authy codes in Bitwarden's export format. You can now import this
 to ente Authenticator!
 
-# Method 2.1: If the export worked, but the import didn't
+### Method 2.1: If the export worked, but the import didn't
 
 > [!NOTE] This is intended only for users who successfully exported their codes
 > using the guide in method 2, but could not import it to ente Authenticator for
@@ -141,7 +145,7 @@ that countains your TOTP secrets, which can now be imported into ente
 Authenticator. To import your codes, please follow one of the steps below,
 depending on which method you used to export your codes.
 
-# Importing to ente Authenticator (Method 1, method 2.1)
+## Importing to ente Authenticator (Method 1, method 2.1)
 
 1. Copy the TXT file to one of your devices with ente Authenticator.
 2. Log in to your account (if you haven't already), or press "Use without
@@ -151,7 +155,7 @@ depending on which method you used to export your codes.
 4. Select the "Plain text" option.
 5. Select the TXT file that was made earlier.
 
-# Importing to ente Authenticator (Method 2)
+## Importing to ente Authenticator (Method 2)
 
 1. Copy the JSON file to one of your devices with ente Authenticator.
 2. Log in to your account (if you haven't already), or press "Use without

+ 19 - 15
docs/docs/self-hosting/guides/custom-server/index.md

@@ -1,9 +1,14 @@
 ---
 title: Custom server
-description: Using a custom self-hosted server with frontend apps
+description: Using a custom self-hosted server with Ente client apps and CLI
 ---
 
-# Custom server for mobile apps
+# Connecting to a custom server
+
+You can modify various Ente client apps and CLI to connect to a self hosted
+custom server endpoint.
+
+## Mobile apps
 
 The pre-built Ente apps from GitHub / App Store / Play Store / F-Droid can be
 easily configured to use a custom server.
@@ -18,12 +23,11 @@ configure the endpoint the app should be connecting to.
 > This is only supported by the Ente Auth app currently. We'll add this same
 > functionality to the Ente Photos app soon.
 
----
-
-# CLI
+## CLI
 
-> [!WARNING] The new version of CLI that supports connecting to custom server is
-> still in beta. You can download the beta version from
+> [!NOTE]
+>
+> You can download the CLI from
 > [here](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0)
 
 Define a config.yaml and put it either in the same directory as CLI or path
@@ -34,10 +38,10 @@ endpoint:
     api: "http://localhost:8080"
 ```
 
-You should be able to
-[add an account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md),
-and subsequently increase the
-[storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
+You should be able to [add an
+account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md),
+and subsequently increase the [storage and account
+validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
 using the CLI.
 
 For the admin actions, you can create `server/museum.yaml`, and whitelist add
@@ -45,10 +49,6 @@ the admin userID `internal.admins`. See
 [local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml#L211C1-L232C1)
 in the server source code for details about how to define this.
 
-You can use
-[account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md)
-command to find the user id of any account.
-
 ```yaml
 ....
 internal:
@@ -57,3 +57,7 @@ internal:
 
 ....
 ```
+
+You can use
+[account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md)
+command to find the user id of any account.