diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index 6bbb0cc842..4f66c9f0d7 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -239,48 +239,48 @@ export const sidebar = [ ], }, { - text: "Self hosting", + text: "Self-hosting", collapsed: true, items: [ { - text: "Get Started", + text: "Quickstart", link: "/self-hosting/", }, { - text: "Install", + text: "Installation", collapsed: true, items: [ { text: "Requirements", - link: "/self-hosting/install/requirements", + link: "/self-hosting/installation/requirements", }, { - text: "Quickstart Script (Recommended)", - link: "/self-hosting/install/quickstart", + text: "Quickstart script (Recommended)", + link: "/self-hosting/installation/quickstart", }, { text: "Docker Compose", - link: "/self-hosting/install/compose", + link: "/self-hosting/installation/compose", }, { - text: "Manual Setup (Without Docker)", - link: "/self-hosting/install/manual", + text: "Manual setup (without Docker)", + link: "/self-hosting/installation/manual", }, { - text: "Environment Variables and Defaults", - link: "/self-hosting/install/env-var", + text: "Environment variables and defaults", + link: "/self-hosting/installation/env-var", }, { text: "Configuration", - link: "/self-hosting/install/config", + link: "/self-hosting/installation/config", }, { - text: "Post-installation Steps", - link: "/self-hosting/install/post-install/", + text: "Post-installation steps", + link: "/self-hosting/installation/post-install/", }, { - text: "Upgrade", - link: "/self-hosting/install/upgrade/", + text: "Upgradation", + link: "/self-hosting/installation/upgradation", } ], @@ -290,15 +290,15 @@ export const sidebar = [ collapsed: true, items: [ { - text: "User Management", + text: "User management", link: "/self-hosting/administration/users", }, { - text: "Reverse Proxy", + text: "Reverse proxy", link: "/self-hosting/administration/reverse-proxy", }, { - text: "Object Storage", + text: "Object storage", link: "/self-hosting/administration/object-storage", }, { @@ -306,19 +306,19 @@ export const sidebar = [ link: "/self-hosting/administration/cli", }, { - text: "Backup and Restore", + text: "Backup", link: "/self-hosting/administration/backup", }, ], }, { - text: "Developer", + text: "Development", collapsed: true, items: [ { text: "Building mobile apps", - link: "/self-hosting/developer/mobile-build" + link: "/self-hosting/development/mobile-build" } ] }, diff --git a/docs/docs/self-hosting/administration/backup.md b/docs/docs/self-hosting/administration/backup.md index d391f49f81..b62aaf6e8f 100644 --- a/docs/docs/self-hosting/administration/backup.md +++ b/docs/docs/self-hosting/administration/backup.md @@ -1,5 +1,5 @@ --- -title: Backups +title: Backups - Self-hosting description: General introduction to backing up your self hosted Ente instance --- diff --git a/docs/docs/self-hosting/administration/cli.md b/docs/docs/self-hosting/administration/cli.md index bdd1743ff2..07240623c3 100644 --- a/docs/docs/self-hosting/administration/cli.md +++ b/docs/docs/self-hosting/administration/cli.md @@ -1,5 +1,5 @@ --- -title: Ente CLI for Self-hosted Instance +title: Ente CLI for Self-hosted Instance - Self-hosting description: Guide to configuring Ente CLI for Self Hosted Instance --- diff --git a/docs/docs/self-hosting/administration/object-storage.md b/docs/docs/self-hosting/administration/object-storage.md index 0d9852aa20..91a86c4698 100644 --- a/docs/docs/self-hosting/administration/object-storage.md +++ b/docs/docs/self-hosting/administration/object-storage.md @@ -1,5 +1,5 @@ --- -title: Configuring Object Storage +title: Configuring Object Storage - Self-hosting description: Configure Object Storage for storing files along with some troubleshooting tips --- diff --git a/docs/docs/self-hosting/administration/reverse-proxy.md b/docs/docs/self-hosting/administration/reverse-proxy.md index fb20a25afc..52867d814f 100644 --- a/docs/docs/self-hosting/administration/reverse-proxy.md +++ b/docs/docs/self-hosting/administration/reverse-proxy.md @@ -1,5 +1,5 @@ --- -Title: Configuring Reverse Proxy +Title: Configuring Reverse Proxy - Self-hosting Description: Configuring reverse proxy for Museum and other services --- diff --git a/docs/docs/self-hosting/developer/mobile-build.md b/docs/docs/self-hosting/development/mobile-build.md similarity index 100% rename from docs/docs/self-hosting/developer/mobile-build.md rename to docs/docs/self-hosting/development/mobile-build.md diff --git a/docs/docs/self-hosting/guides/index.md b/docs/docs/self-hosting/guides/index.md index 407cbe244f..e70dd690a1 100644 --- a/docs/docs/self-hosting/guides/index.md +++ b/docs/docs/self-hosting/guides/index.md @@ -1,5 +1,5 @@ --- -title: Self Hosting +title: Guides - Self-hosting description: Guides for self hosting Ente Photos and/or Ente Auth --- @@ -10,14 +10,8 @@ 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]. +- If you're just looking to get started, see installation. -- For various admin related tasks, e.g. increasing the storage quota on your - self hosted instance, see [administering your custom server]. +- For various administrative tasks, e.g. increasing the storage quota for user on your self-hosted instance, see [user management](/self-hosting/administration/users). -- For configuring your S3 buckets to get the object storage to work from your - mobile device or for fixing an upload errors, see - configuring S3. There is also a longer - community contributed guide for a more self hosted setup of - both the server and web app using external S3 buckets for object storage. +- For configuring your S3 buckets to get the object storage to work from your mobile device or for fixing an upload errors, see [object storage](/self-hosting/administration/object-storage). diff --git a/docs/docs/self-hosting/guides/systemd.md b/docs/docs/self-hosting/guides/systemd.md index 2a7bd08d4b..47fbe5ce0e 100644 --- a/docs/docs/self-hosting/guides/systemd.md +++ b/docs/docs/self-hosting/guides/systemd.md @@ -14,6 +14,6 @@ Please check the below links if you want to run Museum as a service, both of the 1. [How to run museum as a systemd service](https://gist.github.com/mngshm/a0edb097c91d1dc45aeed755af310323) 2. [Museum.service](https://github.com/ente-io/ente/blob/23e678889189157ecc389c258267685934b83631/server/scripts/deploy/museum.service#L4) -Once you are done with setting and running Museum, all you are left to do is run the web app and set up reverse proxy. Check out the documentation for [more information](/self-hosting/install/manual#step-3-configure-web-application). +Once you are done with setting and running Museum, all you are left to do is run the web app and set up reverse proxy. Check out the documentation for [more information](/self-hosting/installation/manual#step-3-configure-web-application). > **Credits:** [mngshm](https://github.com/mngshm) \ No newline at end of file diff --git a/docs/docs/self-hosting/guides/tailscale.md b/docs/docs/self-hosting/guides/tailscale.md index 43aadca7a2..e7f5975f8a 100644 --- a/docs/docs/self-hosting/guides/tailscale.md +++ b/docs/docs/self-hosting/guides/tailscale.md @@ -1,5 +1,5 @@ --- -title: Self Hosting with Tailscale (Community) +title: Self-hosting with Tailscale - Self-hosting description: Guides for self-hosting Ente Photos and/or Ente Auth with Tailscale --- diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index e8ff85a6a1..31532b8557 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -1,9 +1,9 @@ --- -title: Get Started - Self-hosting +title: Quickstart - Self-hosting description: Getting started with self-hosting Ente --- -# Get Started +# Quickstart If you're looking to spin up Ente on your server for preserving those sweet memories or using Auth for 2FA codes, you are in the right place! @@ -21,7 +21,7 @@ ways of self-hosting Ente on your server as described in the documentation. - [Docker Compose](https://docs.docker.com/compose/) > For more details, check out the -> [requirements page](/self-hosting/install/requirements). +> [requirements page](/self-hosting/installation/requirements). ## Set up the server @@ -42,8 +42,6 @@ directory, prompts to start the cluster with needed containers after pulling the ## Try the web app -The first user to be registered will be treated as the admin user. - Open Ente Photos web app at `http://:3000` (or `http://localhost:3000` if using on same local machine) and select **Don't have an account?** to create a new user. @@ -54,8 +52,7 @@ Follow the prompts to sign up. ![Sign Up Page](/sign-up.png) -You will be prompted to enter verification code. Check the cluster logs using -`sudo docker compose logs` and enter the same. +You will be prompted to enter verification code. Check the cluster logs using `sudo docker compose logs` and enter the same. ![Verification Code](/otp.png) @@ -65,33 +62,13 @@ Alternatively, if using Ente Auth, get started by adding an account (assuming yo ## Try the mobile app -### Install the Mobile App +You can install Ente Photos from [here](/photos/faq/installing) and Ente Auth from [here](/auth/faq/installing). -You can install Ente Photos by following the [installation section](/photos/faq/installing). - -Alternatively, you can install Ente Auth (if you are planning to use Auth) by following the [installation section](/auth/faq/installing). - -### Login to the Mobile App - -Tap the onboarding screen 7 times to modify developer settings. - -
-Developer Settings -
- -
-Enter your Ente server's endpoint. -
- -
-Developer Settings - Server Endpoint -
- -You should be able to access the uploaded picture from the web user interface. +Connect to your server from [mobile apps](/self-hosting/installation/post-install/#step-6-configure-apps-to-use-your-server). ## What next? -Now that you have spinned up a cluster in quick manner, you may wish to install using a different way for your needs. Check the "Install" section for information regarding that. +Now that you have spinned up a cluster in quick manner, you may wish to install using a different way for your needs. Check the "Installation" section for information regarding that. You can import your pictures from Google Takeout or from other services to Ente Photos. For more information, check out our [migration guide](/photos/migration/). diff --git a/docs/docs/self-hosting/install/compose.md b/docs/docs/self-hosting/installation/compose.md similarity index 85% rename from docs/docs/self-hosting/install/compose.md rename to docs/docs/self-hosting/installation/compose.md index 3aa60ce9ab..b6515aadf0 100644 --- a/docs/docs/self-hosting/install/compose.md +++ b/docs/docs/self-hosting/installation/compose.md @@ -1,5 +1,5 @@ --- -title: Docker Compose +title: Docker Compose - Self-hosting description: Running Ente with Docker Compose from source --- @@ -9,8 +9,7 @@ If you wish to run Ente via Docker Compose from source, do the following: ## Requirements -Check out the [requirements](/self-hosting/install/requirements) page to get -started. +Check out the [requirements](/self-hosting/installation/requirements) page to get started. ## Step 1: Clone the repository @@ -51,5 +50,5 @@ docker compose up --build This builds Museum and web applications based on the Dockerfile and starts the containers needed for Ente. ::: tip -Check out [post-installation steps](/self-hosting/install/post-install/) for further usage. +Check out [post-installation steps](/self-hosting/installation/post-install/) for further usage. ::: \ No newline at end of file diff --git a/docs/docs/self-hosting/install/config.md b/docs/docs/self-hosting/installation/config.md similarity index 99% rename from docs/docs/self-hosting/install/config.md rename to docs/docs/self-hosting/installation/config.md index 794e095cb5..bdddbde65a 100644 --- a/docs/docs/self-hosting/install/config.md +++ b/docs/docs/self-hosting/installation/config.md @@ -1,5 +1,5 @@ --- -title: "Configuration - Self-hosting" +title: Configuration - Self-hosting description: "Information about all the configuration variables needed to run Ente with museum.yaml" diff --git a/docs/docs/self-hosting/installation/connect.md b/docs/docs/self-hosting/installation/connect.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/docs/self-hosting/install/env-var.md b/docs/docs/self-hosting/installation/env-var.md similarity index 97% rename from docs/docs/self-hosting/install/env-var.md rename to docs/docs/self-hosting/installation/env-var.md index ee60836ab4..4589ef806a 100644 --- a/docs/docs/self-hosting/install/env-var.md +++ b/docs/docs/self-hosting/installation/env-var.md @@ -1,11 +1,11 @@ --- -title: "Environment Variables and Defaults - Self-hosting" +title: Environment variables and defaults - Self-hosting description: "Information about all the configuration variables needed to run Ente along with description on default configuration" --- -# Environment Variables and Defaults +# Environment variables and defaults The environment variables needed for running Ente and the default configuration are documented below: diff --git a/docs/docs/self-hosting/install/manual.md b/docs/docs/self-hosting/installation/manual.md similarity index 95% rename from docs/docs/self-hosting/install/manual.md rename to docs/docs/self-hosting/installation/manual.md index 1a61a89726..9e62485be3 100644 --- a/docs/docs/self-hosting/install/manual.md +++ b/docs/docs/self-hosting/installation/manual.md @@ -1,9 +1,9 @@ --- -title: Manual Setup (Without Docker) - Self-hosting +title: Manual setup (without Docker) - Self-hosting description: Installing and setting up Ente without Docker --- -# Manual Setup (Without Docker) +# Manual setup (without Docker) If you wish to run Ente from source without using Docker, follow the steps described below: @@ -188,8 +188,8 @@ relative to `server` directory } ``` - The web application for Ente Photos should be accessible at http://localhost:3000, check out the [default ports](/self-hosting/install/env-var#ports) for more information. + The web application for Ente Photos should be accessible at http://localhost:3000, check out the [default ports](/self-hosting/installation/env-var#ports) for more information. ::: tip -Check out [post-installation steps](/self-hosting/install/post-install/) for further usage. +Check out [post-installation steps](/self-hosting/installation/post-install/) for further usage. ::: \ No newline at end of file diff --git a/docs/docs/self-hosting/install/post-install/custom-server.png b/docs/docs/self-hosting/installation/post-install/custom-server.png similarity index 100% rename from docs/docs/self-hosting/install/post-install/custom-server.png rename to docs/docs/self-hosting/installation/post-install/custom-server.png diff --git a/docs/docs/self-hosting/install/post-install/index.md b/docs/docs/self-hosting/installation/post-install/index.md similarity index 89% rename from docs/docs/self-hosting/install/post-install/index.md rename to docs/docs/self-hosting/installation/post-install/index.md index 83adf66ede..4290beb355 100644 --- a/docs/docs/self-hosting/install/post-install/index.md +++ b/docs/docs/self-hosting/installation/post-install/index.md @@ -3,7 +3,7 @@ title: Post-installation steps - Self-hosting description: Steps to be followed post-installation for smooth experience --- -# Post-installation Steps +# Post-installation steps A list of steps that should be done after installing Ente are described below: @@ -114,10 +114,19 @@ You can modify Ente mobile apps and CLI to connect to your server. ### Mobile -Tap 7 times on the onboarding screen to configure the -server endpoint to be used. +Tap the onboarding screen 7 times to modify developer settings. -![Setting a custom server on the onboarding screen](custom-server.png) +
+Developer Settings +
+ +
+Enter your Ente server's endpoint. +
+ +
+Developer Settings - Server Endpoint +
### Desktop @@ -137,5 +146,5 @@ You can download Ente CLI from [here](https://github.com/ente-io/ente/releases?q Check our [documentation](/self-hosting/administration/cli) on how to use Ente CLI for managing self-hosted instances. ::: info For upgradation -Check out our [documentation](/self-hosting/install/upgrade) for various installation methods. +Check out our [upgradation documentation](/self-hosting/installation/upgradation) for various installation methods. ::: \ No newline at end of file diff --git a/docs/docs/self-hosting/install/post-install/web-custom-endpoint-indicator.png b/docs/docs/self-hosting/installation/post-install/web-custom-endpoint-indicator.png similarity index 100% rename from docs/docs/self-hosting/install/post-install/web-custom-endpoint-indicator.png rename to docs/docs/self-hosting/installation/post-install/web-custom-endpoint-indicator.png diff --git a/docs/docs/self-hosting/install/post-install/web-dev-settings.png b/docs/docs/self-hosting/installation/post-install/web-dev-settings.png similarity index 100% rename from docs/docs/self-hosting/install/post-install/web-dev-settings.png rename to docs/docs/self-hosting/installation/post-install/web-dev-settings.png diff --git a/docs/docs/self-hosting/install/quickstart.md b/docs/docs/self-hosting/installation/quickstart.md similarity index 76% rename from docs/docs/self-hosting/install/quickstart.md rename to docs/docs/self-hosting/installation/quickstart.md index bcb371e672..ca28f20301 100644 --- a/docs/docs/self-hosting/install/quickstart.md +++ b/docs/docs/self-hosting/installation/quickstart.md @@ -1,16 +1,16 @@ --- -title: Quickstart Script (Recommended) - Self-hosting +title: Quickstart script (Recommended) - Self-hosting description: Self-hosting Ente with quickstart script --- -# Quickstart Script (Recommended) +# Quickstart script (Recommended) We provide a quickstart script which can be used for self-hosting Ente on your machine in less than a minute. ## Requirements -Check out the [requirements](/self-hosting/install/requirements) page to get +Check out the [requirements](/self-hosting/installation/requirements) page to get started. ## Getting started @@ -31,5 +31,5 @@ The data accessed by Museum is stored in `./data` folder inside `my-ente` direct It contains extra configuration files that is to be used (push notification credentials, etc.) ::: tip -Check out [post-installations steps](/self-hosting/install/post-install/) for further usage. +Check out [post-installations steps](/self-hosting/installation/post-install/) for further usage. ::: \ No newline at end of file diff --git a/docs/docs/self-hosting/install/requirements.md b/docs/docs/self-hosting/installation/requirements.md similarity index 97% rename from docs/docs/self-hosting/install/requirements.md rename to docs/docs/self-hosting/installation/requirements.md index 7cfb908f08..a2e5f2f933 100644 --- a/docs/docs/self-hosting/install/requirements.md +++ b/docs/docs/self-hosting/installation/requirements.md @@ -1,5 +1,5 @@ --- -title: Requirements +title: Requirements - Self-hosting description: Requirements for self-hosting Ente --- diff --git a/docs/docs/self-hosting/install/upgrade.md b/docs/docs/self-hosting/installation/upgradation.md similarity index 96% rename from docs/docs/self-hosting/install/upgrade.md rename to docs/docs/self-hosting/installation/upgradation.md index 53c62860a8..b4b11a70bc 100644 --- a/docs/docs/self-hosting/install/upgrade.md +++ b/docs/docs/self-hosting/installation/upgradation.md @@ -56,7 +56,7 @@ based on the updated source code. git pull ``` -2. Follow the steps described in [manual setup](/self-hosting/install/manual) for Museum and web applications. +2. Follow the steps described in [manual setup](/self-hosting/installation/manual) for Museum and web applications. ::: tip diff --git a/docs/docs/self-hosting/troubleshooting/keyring.md b/docs/docs/self-hosting/troubleshooting/keyring.md index a521a13c27..8ef322ff7a 100644 --- a/docs/docs/self-hosting/troubleshooting/keyring.md +++ b/docs/docs/self-hosting/troubleshooting/keyring.md @@ -1,13 +1,11 @@ --- -title: Ente CLI Secrets +title: Ente CLI Secrets - Self-hosting description: A quick hotfix for keyring errors while running Ente CLI. --- # Ente CLI Secrets -Ente CLI makes use of system keyring for storing sensitive information like your -passwords. And running the CLI straight out of the box might give you some -errors related to keyrings in some case. +Ente CLI makes use of system keyring for storing sensitive information like your passwords. And running the CLI straight out of the box might give you some errors related to keyrings in some case. Follow the below steps to run Ente CLI and also avoid keyrings errors. @@ -20,15 +18,12 @@ export ENTE_CLI_SECRETS_PATH=./ ./ente-cli ``` -You can also add the above line to your shell's rc file, to prevent the need to -export manually every time. +You can also add the above line to your shell's rc file, to prevent the need to export manually every time. Then one of the following: -1. If the file doesn't exist, Ente CLI will create it and fill it with a random - 32 character encryption key. -2. If you do create the file, please fill it with a cryptographically generated - 32 byte string. +1. If the file doesn't exist, Ente CLI will create it and fill it with a random 32 character encryption key. +2. If you do create the file, please fill it with a cryptographically generated 32 byte string. And you are good to go. diff --git a/docs/docs/self-hosting/troubleshooting/misc.md b/docs/docs/self-hosting/troubleshooting/misc.md index 8da0e8d141..da901c04c8 100644 --- a/docs/docs/self-hosting/troubleshooting/misc.md +++ b/docs/docs/self-hosting/troubleshooting/misc.md @@ -1,5 +1,5 @@ --- -title: General troubleshooting cases +title: General troubleshooting cases - Self-hosting description: Fixing various errors when trying to self host Ente --- diff --git a/docs/docs/self-hosting/troubleshooting/uploads.md b/docs/docs/self-hosting/troubleshooting/uploads.md index ad1cf2b74d..28761da80e 100644 --- a/docs/docs/self-hosting/troubleshooting/uploads.md +++ b/docs/docs/self-hosting/troubleshooting/uploads.md @@ -1,5 +1,5 @@ --- -title: Uploads +title: Uploads - Self-hosting description: Fixing upload errors when trying to self host Ente --- @@ -8,19 +8,14 @@ description: Fixing upload errors when trying to self host Ente Here are some errors our community members frequently encountered with the context and potential fixes. -Fundamentally in most situations, the problem is because of minor mistakes or -misconfiguration. Please make sure to reverse proxy museum and MinIO API -endpoint to a domain and check your S3 credentials and whole configuration file -for any minor misconfigurations. +Fundamentally in most situations, the problem is because of minor mistakes or misconfiguration. Please make sure to reverse proxy Museum and MinIO API +endpoint to a domain and check your S3 credentials and whole configuration file for any minor misconfigurations. -It is also suggested that the user setups bucket CORS or global CORS on MinIO or -any external S3 service provider they are connecting to. To setup bucket CORS, -please [read this]. +It is also suggested that the user setups bucket CORS or global CORS on MinIO or any external S3 service provider they are connecting to. To setup bucket CORS, please [read this](/self-hosting/administration/object-storage#cors-cross-origin-resource-sharing). ## 403 Forbidden -If museum is able to make a network connection to your S3 bucket but uploads are -still failing, it could be a credentials or permissions issue. +If museum is able to make a network connection to your S3 bucket but uploads are still failing, it could be a credentials or permissions issue. A telltale sign of this is that in the museum logs you can see `403 Forbidden` errors about it not able to find the size of a file even though the @@ -34,12 +29,8 @@ This could be because headers configuration too. [Here is an example of a working configuration](https://github.com/ente-io/ente/discussions/1764#discussioncomment-9478204). -2. The credentials are not being picked up (you might be setting the correct - credentials, but not in the place where museum reads them from). +2. The credentials are not being picked up (you might be setting the correct credentials, but not in the place where museum reads them from). ## Mismatch in file size -The "Mismatch in file size" error mostly occurs in a situation where the client -is re-uploading a file which is already in the bucket with a different file -size. The reason for re-upload could be anything including network issue, sudden -killing of app before the upload is complete and etc. +The "Mismatch in file size" error mostly occurs in a situation where the client is re-uploading a file which is already in the bucket with a different file size. The reason for re-upload could be anything including network issue, sudden killing of app before the upload is complete and etc. diff --git a/docs/docs/self-hosting/troubleshooting/yarn.md b/docs/docs/self-hosting/troubleshooting/yarn.md deleted file mode 100644 index 4cc62c405b..0000000000 --- a/docs/docs/self-hosting/troubleshooting/yarn.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Yarn errors -description: Fixing yarn install errors when trying to self host Ente ---- - -# Yarn - -If `yarn install` is failing, make sure you are using Yarn v1 (also known as -"Yarn Classic"): - -- https://classic.yarnpkg.com/lang/en/docs/install - -For more details, see the -[getting started instructions](https://github.com/ente-io/ente/blob/main/web/docs/new.md).