diff --git a/auth/migration-guides/README.md b/auth/migration-guides/README.md new file mode 100644 index 000000000..56d8983d0 --- /dev/null +++ b/auth/migration-guides/README.md @@ -0,0 +1,4 @@ +Migration guides have moved to the [help +docs](https://help.ente.io/auth/migration-guides/). This folder just contains +redirects for old links. + diff --git a/auth/migration-guides/authy.md b/auth/migration-guides/authy.md index 4a0ad936b..630bc83c7 100644 --- a/auth/migration-guides/authy.md +++ b/auth/migration-guides/authy.md @@ -1,109 +1,2 @@ -# Migrating from Authy -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. - ---- - -Migrating from Authy can be tiring, as you cannot export your 2FA codes through the app, meaning that you would have to reconfigure 2FA for all of your accounts 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! -> -> 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 deleting any codes from your Authy account! - ---- - -# 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.

- -One way to export is to [use this tool by Neeraj](https://github.com/ua741/authy-export/releases/tag/v0.0.4) to simplify the process and skip directly to importing to ente Authenticator. - -To export from Authy, download the tool for your specific OS, then type the following in your terminal: -``` -./ -``` - -Assuming the filename of the binary remains unmodified and the working directory of the terminal is the location of the binary, you should type this for MacOS: -> [!NOTE] -> On Apple Silicon devices, Rosetta 2 may be required to run the binary. -``` -./authy-export-darwin-amd64 authy_codes.txt -``` - -For Linux: -``` -./authy-export-linux-amd64 authy_codes.txt -``` - -For Windows: -``` -./authy-export-windows-amd64.exe authy_codes.txt -``` - -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 -**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.

- -A user on GitHub (gboudreau) wrote a guide to export codes from Authy (morpheus on Discord found this and showed it to us), so we are going to be using that for the migration. - -To export your data, please follow [this guide](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93). - -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 -> [!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 whatever reason. If the import was successful, or you haven't tried to import the codes yet, ignore this section. -> -> If the export itself failed, try using [**method 1**](#method-1-use-neerajs-export-tool) instead. - -Usually, you should be able to import Bitwarden exports directly into ente Authenticator. In case this didn't work for whatever reason, I've written a program in Python that converts the JSON file into a TXT file that ente Authenticator can use, so you can try importing using plain text import instead. - -You can download my program [here](https://github.com/gweeeen/ducky/blob/main/duckys_other_stuff/authy_to_ente.py), or you can copy the program below: -```py -import json -import os - -totp = [] - -accounts = json.load(open('authy-to-bitwarden-export.json','r',encoding='utf-8')) - -for account in accounts['items']: - totp.append(account['login']['totp']+'\n') - -writer = open('auth_codes.txt','w+',encoding='utf-8') -writer.writelines(totp) -writer.close() - -print('Saved to ' + os.getcwd() + '/auth_codes.txt') -``` - -To convert the file with this program, you will need to install [Python](https://www.python.org/downloads/) on your computer. - -Before you run the program, make sure that both the Python program and the JSON file are in the same directory, otherwise this will not work! - -To run the Python program, open it in your IDE and run the program, or open your terminal and type `python3 authy_to_ente.py` (MacOS/Linux, or any other OS that uses bash) or `py -3 authy_to_ente.py` (Windows). Once you run it, a new TXT file called `auth_codes.txt` will be generated. You can now import your data to ente Authenticator! - ---- -You should now have a TXT file (method 1, method 2.1) or a JSON file (method 2) 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) -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 backups". -3. Open the navigation menu (hamburger button on the top left), then press "Data", then press "Import codes". -4. Select the "Plain text" option. -5. Select the TXT file that was made earlier. - -# 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 backups". -3. Open the navigation menu (hamburger button on the top left), then press "Data", then press "Import codes". -4. Select the "Bitwarden" option. -5. Select the JSON file that was made earlier. - -If this didn't work, refer to [**method 2.1**](#method-21-if-the-export-worked-but-the-import-didnt).

- -And that's it! You have now successfully migrated from Authy to ente Authenticator. - -Now that your secrets are safely stored, I recommend you delete the unencrypted JSON and TXT files that were made during the migration process for security. +Moved to +[help.ente.io/auth/migration-guides/authy](https://help.ente.io/auth/migration-guides/authy/) diff --git a/auth/migration-guides/encrypted_export.md b/auth/migration-guides/encrypted_export.md index b4e64134e..80a844c85 100644 --- a/auth/migration-guides/encrypted_export.md +++ b/auth/migration-guides/encrypted_export.md @@ -1,63 +1,2 @@ -# Auth Encrypted Export format - -## Overview - -When we export the auth codes, the data is encrypted using a key derived from the user's password. -This document describes the JSON structure used to organize exported data, including versioning and key derivation -parameters. - -## Export JSON Sample - -```json -{ - "version": 1, - "kdfParams": { - "memLimit": 4096, - "opsLimit": 3, - "salt": "example_salt" - }, - "encryptedData": "encrypted_data_here", - "encryptionNonce": "nonce_here" -} -``` - -The main object used to represent the export data. It contains the following key-value pairs: - -- `version`: The version of the export format. -- `kdfParams`: Key derivation function parameters. -- `encryptedData"`: The encrypted authentication data. -- `encryptionNonce`: The nonce used for encryption. - -### Version - -Export version is used to identify the format of the export data. - -#### Ver: 1 - -* KDF Algorithm: `ARGON2ID` -* Decrypted data format: `otpauth://totp/...`, separated by a new line. -* Encryption Algo: `XChaCha20-Poly1305` - -#### Key Derivation Function Params (KDF) - -This section contains the parameters that were using during KDF operation: - -- `memLimit`: Memory limit for the algorithm. -- `opsLimit`: Operations limit for the algorithm. -- `salt`: The salt used in the derivation process. - -#### Encrypted Data - -As mentioned above, the auth data is encrypted using a key that's derived by using user provided password & kdf params. -For encryption, we are using `XChaCha20-Poly1305` algorithm. - -## How to use the exported data - -* **Ente Authenticator app**: You can directly import the codes in the Ente Authenticator app. - > Settings -> Data -> Import Codes -> ente Encrypted export. - -* **Decrypt using Ente CLI** : Download the latest version of [Ente CLI](https://github.com/ente-io/ente/releases?q=CLI&expanded=false), and run the following command - -``` - ./ente auth decrypt -``` +Moved to +[help.ente.io/auth/migration-guides/export](https://help.ente.io/auth/migration-guides/export/) diff --git a/cli/README.md b/cli/README.md index 5a4097a46..8fc9aa694 100644 --- a/cli/README.md +++ b/cli/README.md @@ -7,7 +7,7 @@ use it to decrypting the export from Ente Auth. ## Install The easiest way is to download a pre-built binary from the [GitHub -releases](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0&expanded=true). +releases](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0). You can also build these binaries yourself diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index 8d5082739..ca531716b 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -69,9 +69,17 @@ export const sidebar = [ { text: "FAQ", link: "/auth/faq/" }, { text: "Migration guides", - collapsed: true, + collapsed: false, items: [ - { text: "From Authy", link: "/auth/migration-guides/authy/" }, + { text: "Introduction", link: "/auth/migration-guides/" }, + { + text: "From Authy", + link: "/auth/migration-guides/authy/", + }, + { + text: "Exporting your data", + link: "/auth/migration-guides/export", + }, ], }, ], @@ -86,9 +94,14 @@ 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/", }, + { + text: "Administering your server", + link: "/self-hosting/guides/admin", + }, + { text: "Mobile build", link: "/self-hosting/guides/mobile-build", @@ -110,6 +123,10 @@ export const sidebar = [ text: "Verification code", link: "/self-hosting/faq/otp", }, + { + text: "Increase storage space", + link: "/self-hosting/faq/storage-space", + }, ], }, { diff --git a/docs/docs/auth/faq/index.md b/docs/docs/auth/faq/index.md index e40d18431..23564e2e3 100644 --- a/docs/docs/auth/faq/index.md +++ b/docs/docs/auth/faq/index.md @@ -1,21 +1,33 @@ - +--- +title: FAQ - Auth +description: Frequently asked questions about Ente Auth +--- # Frequently Asked Questions -### How secure is ente Auth? -All codes you backup via Ente is stored end-to-end encrypted. This means only you can access your codes. Our apps are open source and our cryptography has been externally audited. +### How secure is Ente Auth? + +All codes you backup via Ente is stored end-to-end encrypted. This means only +you can access your codes. Our apps are open source and our cryptography has +been externally audited. ### Can I access my codes on desktop? -You can access your codes on the web @ [auth.ente.io](https://auth.ente.io). + +You can access your codes on the web at [auth.ente.io](https://auth.ente.io). ### How can I delete or edit codes? + You can delete or edit a code by swiping left on that item. ### How can I support this project? -You can support the development of this project by subscribing to our Photos app @ [ente.io](https://ente.io). + +You can support the development of this project by subscribing to our Photos app +at [ente.io](https://ente.io). ### How can I enable FaceID lock in Ente Auth? + You can enable FaceID lock under Settings → Security → Lockscreen. ### Why does the desktop and mobile app displays different code? + Please verify that the time on both your mobile and desktop is same. diff --git a/docs/docs/auth/index.md b/docs/docs/auth/index.md index 11fb333af..8800c5422 100644 --- a/docs/docs/auth/index.md +++ b/docs/docs/auth/index.md @@ -7,8 +7,3 @@ description: User guide for Ente Auth Ente Auth is a free, cross-platform, end-to-end encrypted authenticator app. You can use it to safely store your 2FA codes (second-factor authentication codes). - -> [!CAUTION] -> -> These docs are still incomplete. If you feel like documenting an issue you ran -> into and then found a solution to, help us [fill them in](/about/contribute). diff --git a/docs/docs/auth/migration-guides/authy/index.md b/docs/docs/auth/migration-guides/authy/index.md index 4a0ad936b..7a938bfa1 100644 --- a/docs/docs/auth/migration-guides/authy/index.md +++ b/docs/docs/auth/migration-guides/authy/index.md @@ -1,66 +1,113 @@ +--- +title: Migrating from Authy +description: Guide for importing your existing Authy 2FA tokens into Ente Auth +--- + # Migrating from Authy + 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. --- -Migrating from Authy can be tiring, as you cannot export your 2FA codes through the app, meaning that you would have to reconfigure 2FA for all of your accounts 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. +Migrating from Authy can be tiring, as you cannot export your 2FA codes through +the app, meaning that you would have to reconfigure 2FA for all of your accounts +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! -> -> 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 deleting any codes from your Authy account! +> +> 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 +> deleting any codes from your Authy account! --- -# 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.

+## Method 1: Use Neeraj's export tool -One way to export is to [use this tool by Neeraj](https://github.com/ua741/authy-export/releases/tag/v0.0.4) to simplify the process and skip directly to importing to ente Authenticator. +**Who should use this?** General users who want to save time by skipping the +hard (and rather technical) parts of the process.

+ +One way to export is to +[use this tool by Neeraj](https://github.com/ua741/authy-export/releases/tag/v0.0.4) +to simplify the process and skip directly to importing to ente Authenticator. + +To export from Authy, download the tool for your specific OS, then type the +following in your terminal: -To export from Authy, download the tool for your specific OS, then type the following in your terminal: ``` ./ ``` -Assuming the filename of the binary remains unmodified and the working directory of the terminal is the location of the binary, you should type this for MacOS: -> [!NOTE] -> On Apple Silicon devices, Rosetta 2 may be required to run the binary. +Assuming the filename of the binary remains unmodified and the working directory +of the terminal is the location of the binary, you should type this for MacOS: + +> [!NOTE] On Apple Silicon devices, Rosetta 2 may be required to run the binary. + ``` ./authy-export-darwin-amd64 authy_codes.txt ``` For Linux: + ``` ./authy-export-linux-amd64 authy_codes.txt ``` For Windows: + ``` ./authy-export-windows-amd64.exe authy_codes.txt ``` -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! +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 -**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.

+## Method 2: Use gboudreau's GitHub guide -A user on GitHub (gboudreau) wrote a guide to export codes from Authy (morpheus on Discord found this and showed it to us), so we are going to be using that for the migration. +**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.

-To export your data, please follow [this guide](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93). +A user on GitHub (gboudreau) wrote a guide to export codes from Authy (morpheus +on Discord found this and showed it to us), so we are going to be using that for +the migration. -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! +To export your data, please follow +[this guide](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93). -# 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 whatever reason. If the import was successful, or you haven't tried to import the codes yet, ignore this section. +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 + +> [!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 +> whatever reason. If the import was successful, or you haven't tried to import +> the codes yet, ignore this section. > -> If the export itself failed, try using [**method 1**](#method-1-use-neerajs-export-tool) instead. +> If the export itself failed, try using +> [**method 1**](#method-1-use-neerajs-export-tool) instead. -Usually, you should be able to import Bitwarden exports directly into ente Authenticator. In case this didn't work for whatever reason, I've written a program in Python that converts the JSON file into a TXT file that ente Authenticator can use, so you can try importing using plain text import instead. +Usually, you should be able to import Bitwarden exports directly into ente +Authenticator. In case this didn't work for whatever reason, I've written a +program in Python that converts the JSON file into a TXT file that ente +Authenticator can use, so you can try importing using plain text import instead. + +You can download my program +[here](https://github.com/gweeeen/ducky/blob/main/duckys_other_stuff/authy_to_ente.py), +or you can copy the program below: -You can download my program [here](https://github.com/gweeeen/ducky/blob/main/duckys_other_stuff/authy_to_ente.py), or you can copy the program below: ```py import json import os @@ -79,31 +126,50 @@ writer.close() print('Saved to ' + os.getcwd() + '/auth_codes.txt') ``` -To convert the file with this program, you will need to install [Python](https://www.python.org/downloads/) on your computer. +To convert the file with this program, you will need to install +[Python](https://www.python.org/downloads/) on your computer. -Before you run the program, make sure that both the Python program and the JSON file are in the same directory, otherwise this will not work! +Before you run the program, make sure that both the Python program and the JSON +file are in the same directory, otherwise this will not work! -To run the Python program, open it in your IDE and run the program, or open your terminal and type `python3 authy_to_ente.py` (MacOS/Linux, or any other OS that uses bash) or `py -3 authy_to_ente.py` (Windows). Once you run it, a new TXT file called `auth_codes.txt` will be generated. You can now import your data to ente Authenticator! +To run the Python program, open it in your IDE and run the program, or open your +terminal and type `python3 authy_to_ente.py` (MacOS/Linux, or any other OS that +uses bash) or `py -3 authy_to_ente.py` (Windows). Once you run it, a new TXT +file called `auth_codes.txt` will be generated. You can now import your data to +ente Authenticator! --- -You should now have a TXT file (method 1, method 2.1) or a JSON file (method 2) 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) +You should now have a TXT file (method 1, method 2.1) or a JSON file (method 2) +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) + 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 backups". -3. Open the navigation menu (hamburger button on the top left), then press "Data", then press "Import codes". +2. Log in to your account (if you haven't already), or press "Use without + backups". +3. Open the navigation menu (hamburger button on the top left), then press + "Data", then press "Import 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 backups". -3. Open the navigation menu (hamburger button on the top left), then press "Data", then press "Import codes". +2. Log in to your account (if you haven't already), or press "Use without + backups". +3. Open the navigation menu (hamburger button on the top left), then press + "Data", then press "Import codes". 4. Select the "Bitwarden" option. 5. Select the JSON file that was made earlier. -If this didn't work, refer to [**method 2.1**](#method-21-if-the-export-worked-but-the-import-didnt).

+If this didn't work, refer to +[**method 2.1**](#method-21-if-the-export-worked-but-the-import-didnt).

-And that's it! You have now successfully migrated from Authy to ente Authenticator. +And that's it! You have now successfully migrated from Authy to ente +Authenticator. -Now that your secrets are safely stored, I recommend you delete the unencrypted JSON and TXT files that were made during the migration process for security. +Now that your secrets are safely stored, I recommend you delete the unencrypted +JSON and TXT files that were made during the migration process for security. diff --git a/docs/docs/auth/migration-guides/export.md b/docs/docs/auth/migration-guides/export.md new file mode 100644 index 000000000..a66bea7b6 --- /dev/null +++ b/docs/docs/auth/migration-guides/export.md @@ -0,0 +1,76 @@ +--- +title: Exporting your data from Ente Auth +description: Guide for exporting your 2FA codes out from Ente Auth +--- + +# Exporting your data out of Ente Auth + +## Auth Encrypted Export format + +### Overview + +When we export the auth codes, the data is encrypted using a key derived from +the user's password. This document describes the JSON structure used to organize +exported data, including versioning and key derivation parameters. + +### Export JSON Sample + +```json +{ + "version": 1, + "kdfParams": { + "memLimit": 4096, + "opsLimit": 3, + "salt": "example_salt" + }, + "encryptedData": "encrypted_data_here", + "encryptionNonce": "nonce_here" +} +``` + +The main object used to represent the export data. It contains the following +key-value pairs: + +- `version`: The version of the export format. +- `kdfParams`: Key derivation function parameters. +- `encryptedData"`: The encrypted authentication data. +- `encryptionNonce`: The nonce used for encryption. + +#### Version + +Export version is used to identify the format of the export data. + +##### Ver: 1 + +- KDF Algorithm: `ARGON2ID` +- Decrypted data format: `otpauth://totp/...`, separated by a new line. +- Encryption Algo: `XChaCha20-Poly1305` + +##### Key Derivation Function Params (KDF) + +This section contains the parameters that were using during KDF operation: + +- `memLimit`: Memory limit for the algorithm. +- `opsLimit`: Operations limit for the algorithm. +- `salt`: The salt used in the derivation process. + +##### Encrypted Data + +As mentioned above, the auth data is encrypted using a key that's derived by +using user provided password & kdf params. For encryption, we are using +`XChaCha20-Poly1305` algorithm. + +## How to use the exported data + +- **Ente Authenticator app**: You can directly import the codes in the Ente + Authenticator app. + + > Settings -> Data -> Import Codes -> ente Encrypted export. + +- **Decrypt using Ente CLI** : Download the latest version of + [Ente CLI](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0), and run + the following command + +``` + ./ente auth decrypt +``` diff --git a/docs/docs/auth/migration-guides/index.md b/docs/docs/auth/migration-guides/index.md index 603c87011..f10d9db41 100644 --- a/docs/docs/auth/migration-guides/index.md +++ b/docs/docs/auth/migration-guides/index.md @@ -1,11 +1,10 @@ --- title: Migrating to Ente Auth description: - Guides for migrating your existing 2FA tokens from other products into Ente - Auth + Guides for migrating your existing 2FA tokens into or out of Ente Auth --- -# Migrating to Ente Auth +# Migrating to/from Ente Auth -_Coming soon_. This section will contain guides for migrating your existing 2FA -tokens from other products into Ente Auth. +- [Migrating from Authy](authy/) +- [Exporting your data out of Ente Auth](export) diff --git a/docs/docs/photos/faq/index.md b/docs/docs/photos/faq/index.md index 93eebcb56..c5a4e2cf9 100644 --- a/docs/docs/photos/faq/index.md +++ b/docs/docs/photos/faq/index.md @@ -3,9 +3,7 @@ title: FAQ description: Frequently asked questions about Ente Photos --- - # FAQ - -_Coming soon_. On this page we'll document some help items in a question and answer format. - +_Coming soon_. On this page we'll document some help items in a question and +answer format. diff --git a/docs/docs/self-hosting/faq/storage-space.md b/docs/docs/self-hosting/faq/storage-space.md new file mode 100644 index 000000000..f1ad78c71 --- /dev/null +++ b/docs/docs/self-hosting/faq/storage-space.md @@ -0,0 +1,12 @@ +--- +title: Increase storage space +description: Increasing the storage quota for users on your self hosted instance +--- + +# Increase storage space + +See the [guide for administering your server](/self-hosting/guides/admin). In +particular, you can use the `ente admin update-subscription` CLI command to +increase the +[storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md) +of accounts on your instance. diff --git a/docs/docs/self-hosting/guides/admin.md b/docs/docs/self-hosting/guides/admin.md new file mode 100644 index 000000000..91ea4d0f8 --- /dev/null +++ b/docs/docs/self-hosting/guides/admin.md @@ -0,0 +1,43 @@ +--- +title: Server admin +description: Administering your custom self-hosted Ente instance using the CLI +--- + +# Administering your custom server + +You can use +[Ente's CLI](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0) to +administer your self hosted server. + +First we need to get your CLI to connect to your custom server. Define a +config.yaml and put it either in the same directory as CLI or path defined in +env variable `ENTE_CLI_CONFIG_PATH` + +```yaml +endpoint: + api: "http://localhost:8080" +``` + +Now 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 +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. + +```yaml +.... +internal: + admins: + # - 1580559962386440 + +.... +``` + +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. diff --git a/docs/docs/self-hosting/guides/custom-server/index.md b/docs/docs/self-hosting/guides/custom-server/index.md index 51a9b6c2f..7f7ba50fa 100644 --- a/docs/docs/self-hosting/guides/custom-server/index.md +++ b/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,32 +23,17 @@ 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 +> [!NOTE] +> +> You can download the CLI from +> [here](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0) -> [!WARNING] -> The new version of CLI that supports connecting to custom server is still in beta. -> You can download the beta version from [here](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0&expanded=true) - -Define a config.yaml and put it either in the same directory as CLI or path defined in env variable `ENTE_CLI_CONFIG_PATH` +Define a config.yaml and put it either in the same directory as CLI or path +defined in env variable `ENTE_CLI_CONFIG_PATH` ```yaml endpoint: - api: "http://localhost:8080" + 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) using the CLI. - -For the admin actions, you can create `server/museum.yaml`, and whitelist add 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: - admins: - # - 1580559962386440 - -.... -``` \ No newline at end of file diff --git a/docs/docs/self-hosting/guides/index.md b/docs/docs/self-hosting/guides/index.md index 2f7582e31..a8a64d960 100644 --- a/docs/docs/self-hosting/guides/index.md +++ b/docs/docs/self-hosting/guides/index.md @@ -10,9 +10,11 @@ walkthroughs, tutorials and other FAQ pages in this directory. See the sidebar for existing guides. In particular: -* If you're just looking to get started, see [configure custom - server](custom-server/). +- If you're just looking to get started, see + [configure custom server](custom-server/). -* For self hosting both the server and web app using external S3 buckets for - object storage, see [using external S3](external-s3). +- For various admin related tasks, e.g. increasing the storage quota on your + self hosted instance, see [administering your custom server](admin). +- For self hosting both the server and web app using external S3 buckets for + object storage, see [using external S3](external-s3). diff --git a/docs/docs/self-hosting/guides/mobile-build.md b/docs/docs/self-hosting/guides/mobile-build.md index 32bba3aa7..c36903a20 100644 --- a/docs/docs/self-hosting/guides/mobile-build.md +++ b/docs/docs/self-hosting/guides/mobile-build.md @@ -30,8 +30,6 @@ flutter run --dart-define=endpoint=http://localhost:8080 --flavor independent -- flutter run --dart-define=endpoint=http://localhost:8080 ``` - - Or for the auth app: ```sh @@ -46,9 +44,11 @@ flutter run --dart-define=endpoint=http://localhost:8080 ``` ## How to build non-debug builds -For building APK, [setup your - keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore) - and run -```sh + +For building APK, +[setup your keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore) +and run + +```sh flutter build apk --release --flavor independent -t lib/main.dart - ``` +``` diff --git a/server/README.md b/server/README.md index 9c4b2f696..06fdcb518 100644 --- a/server/README.md +++ b/server/README.md @@ -113,6 +113,11 @@ repository's [Discussions](https://github.com/ente-io/ente/discussions), or on try to clarify, and also document such FAQs. Please feel free to open documentation PRs around this too. +> [!TIP] +> +> You can find more guides and documentation around self-hosting at +> [help.ente.io/self-hosting](https://help.ente.io/self-hosting). + ## Thanks ❤️ We've had great fun with this combination (Golang + Postgres + Docker), and we