diff --git a/docs/docs/index.md b/docs/docs/index.md index 01ba8d448b..8bd27ffd73 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -14,8 +14,8 @@ Ente (pronounced en-_tay_) is a end-to-end encrypted platform for privately, reliably, and securely storing your data on the cloud, over which 2 applications have been developed and made available for mobile, web and desktop, namely: -- **Ente Photos** - An alternative to Google Photos and Apple Photos -- **Ente Auth** - A free 2FA alternative to Authy +- **Ente Photos** - An alternative to Google Photos and Apple Photos. +- **Ente Auth** - A free 2FA alternative to Authy. ## History @@ -76,7 +76,7 @@ and stay updated: If you encounter any issues with any of the products that's not answered by our documentation, please reach out to our team by sending an email to -[support@ente.io](mailto:support@ente.io) +[support@ente.io](mailto:support@ente.io). -For community support, please post your queries on -[Discord](https://discord.gg/z2YVKkycX3) +For community support, please post your queries on our +[Discord](https://discord.gg/z2YVKkycX3) server. diff --git a/docs/docs/self-hosting/administration/cli.md b/docs/docs/self-hosting/administration/cli.md index 6b98a91247..aa485d21c2 100644 --- a/docs/docs/self-hosting/administration/cli.md +++ b/docs/docs/self-hosting/administration/cli.md @@ -29,8 +29,9 @@ You can whitelist administrator users by following this ## Step 3: Add an account -::: detail -You can not create new accounts using Ente CLI. You can only log in to your existing accounts. +::: info You can not create new accounts using Ente CLI. +You can only log in to your existing accounts. + To create a new account, use Ente Photos (or Ente Auth) web application, desktop or mobile. ::: @@ -40,11 +41,11 @@ You can add your existing account using Ente CLI. ente account add ``` -This should prompt you for authentication details. +This should prompt you for authentication details and export directory. +Your account should be added after successful authentication. -Your account should be added and can be used for exporting data -(for plain-text backup), managing Ente Auth and performing -administrative actions. +It can be used for exporting data (for plain-text backup), +managing Ente Auth and performing administrative actions. ## Step 4: Increase storage and account validity @@ -52,11 +53,12 @@ You can use `ente admin update-subscription` to increase storage quota and account validity (duration). For infinite storage and validity, use the following command: + ``` shell -ente admin update-subscription -a -u --no-limit +ente admin update-subscription -a -u --no-limit # Set a limit -ente admin update-subscription -a -u --no-limit False +ente admin update-subscription -a -u --no-limit False ``` For more information, check out the documentation for setting diff --git a/docs/docs/self-hosting/administration/object-storage.md b/docs/docs/self-hosting/administration/object-storage.md index 91a86c4698..7a99d272c1 100644 --- a/docs/docs/self-hosting/administration/object-storage.md +++ b/docs/docs/self-hosting/administration/object-storage.md @@ -92,7 +92,7 @@ Use the content provided below for creating a `cors.json` file: ``` You may have to change the `AllowedOrigins` to allow only certain origins -(your Ente web apps and Museum.) for security. +(your Ente web apps and Museum) for security. Assuming you have AWS CLI on your system and that you have configured it with your access key and secret, you can execute the below command to diff --git a/docs/docs/self-hosting/administration/users.md b/docs/docs/self-hosting/administration/users.md index 86902cd36c..f6cdf5ef6c 100644 --- a/docs/docs/self-hosting/administration/users.md +++ b/docs/docs/self-hosting/administration/users.md @@ -27,7 +27,7 @@ related to Ente). psql -U pguser -d ente_db ``` -2. Get the user ID of the first user by running the following PSQL command: +2. Get the user ID of the first user by running the following SQL query: ``` sql SELECT * from users; ``` diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index bacb8d1924..5f478fb860 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -5,12 +5,14 @@ description: Getting started with self-hosting Ente # Quickstart -If you're looking to spin up Ente on your server , you are in the right place! +If you're looking to spin up Ente on your server, you are in the right place! Our entire source code ([including the server](https://ente.io/blog/open-sourcing-our-server/)) is open source. This is the same code we use on production. -For a quick preview, make sure your system meets the requirements mentioned below. After trying the preview, you can explore other ways of self-hosting Ente on your server as described in the documentation. +For a quick preview, make sure your system meets the requirements mentioned below. +After trying the preview, you can explore other ways of self-hosting Ente on your +server as described in the documentation. ## Requirements @@ -28,12 +30,14 @@ Run this command on your terminal to setup Ente. sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh)" ``` -The above command creates a directory `my-ente` in the current working -directory, prompts to start the cluster with needed containers after pulling the images required to run Ente. +This creates a directory `my-ente` in the current working +directory, prompts to start the cluster with needed containers +after pulling the images required to run Ente. -> [!NOTE] -> Make sure to modify the default values in `compose.yaml` and `museum.yaml` -> if you wish to change endpoints, bucket configuration or server configuration. +::: note +Make sure to modify the default values in `compose.yaml` and `museum.yaml` +if you wish to change endpoints, bucket configuration or server configuration. +::: ## Try the web app diff --git a/docs/docs/self-hosting/installation/connect.md b/docs/docs/self-hosting/installation/connect.md deleted file mode 100644 index e69de29bb2..0000000000