diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index e0ebb61296..7ca16798cf 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -276,8 +276,8 @@ export const sidebar = [ }, { text: "Connecting to Custom Server", - link: "/self-hosting/install/custom-server/" - } + link: "/self-hosting/install/custom-server/", + }, ], }, { @@ -314,7 +314,7 @@ export const sidebar = [ { text: "Configuring CLI for your instance", link: "/self-hosting/guides/selfhost-cli", - } + }, ], }, { @@ -373,7 +373,7 @@ export const sidebar = [ { text: "Backups", link: "/self-hosting/faq/backup", - } + }, ], }, ], diff --git a/docs/docs/index.md b/docs/docs/index.md index fc320f86b4..fa15f6be8b 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -19,8 +19,8 @@ have been developed and made available for mobile, web and desktop, namely: ## History -Ente was the founded by Vishnu Mohandas (Ente's CEO) in response to -privacy concerns with major tech companies. The underlying motivation was the +Ente was the founded by Vishnu Mohandas (Ente's CEO) in response to privacy +concerns with major tech companies. The underlying motivation was the understanding that big tech had no incentive to fix their act, but with end-to-end encrypted cross platform apps, there was a way for people to take back control over their own data without sacrificing on features. diff --git a/docs/docs/public/developer-settings-endpoint.png b/docs/docs/public/developer-settings-endpoint.png new file mode 100644 index 0000000000..11ab74d61e Binary files /dev/null and b/docs/docs/public/developer-settings-endpoint.png differ diff --git a/docs/docs/public/developer-settings.png b/docs/docs/public/developer-settings.png new file mode 100644 index 0000000000..6774f85598 Binary files /dev/null and b/docs/docs/public/developer-settings.png differ diff --git a/docs/docs/self-hosting/guides/configuring-s3.md b/docs/docs/self-hosting/guides/configuring-s3.md index c82de3fe25..744760ed7e 100644 --- a/docs/docs/self-hosting/guides/configuring-s3.md +++ b/docs/docs/self-hosting/guides/configuring-s3.md @@ -14,7 +14,8 @@ description: > As of now, replication works only if all the 3 storage type needs are > fulfilled (1 hot, 1 cold and 1 glacier storage). > -> For more information, check this [discussion](https://github.com/ente-io/ente/discussions/3167#discussioncomment-10585970). +> For more information, check this +> [discussion](https://github.com/ente-io/ente/discussions/3167#discussioncomment-10585970). If you're wondering why there are 3 buckets on the MinIO UI - that's because our production instance uses these to perform diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index d5c76eaa72..13fadbaa6c 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -6,16 +6,20 @@ description: Getting started with self-hosting Ente # Get Started The entire source code for Ente is open source, -[including the servers](https://ente.io/blog/open-sourcing-our-server/). This is the same code we use for our own cloud service. +[including the server](https://ente.io/blog/open-sourcing-our-server/). This is +the same code we use for our own cloud service. -For a quick preview of running Ente on your server, make sure you have the following installed on your system and meets the requirements mentioned below: +For a quick preview of Ente on your server, 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 - A system with at least 1 GB of RAM and 1 CPU core - [Docker Compose v2](https://docs.docker.com/compose/) -> For more details, check out [requirements page](/self-hosting/install/requirements) +> For more details, check out the +> [requirements page](/self-hosting/install/requirements). ## Set up the server @@ -25,7 +29,9 @@ 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 after pulling the images and starts all the containers required to run Ente. +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. ![quickstart](/quickstart.png) @@ -33,7 +39,9 @@ The above command creates a directory `my-ente` in the current working directory The first user to be registered will be treated as the admin user. -Open the 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. +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. ![Onboarding Screen](/onboarding.png) @@ -41,16 +49,49 @@ 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) +Upload a picture via the web user interface. + +Alternatively, if using Ente Auth, get started by adding an account (assuming you are running Ente Auth at `http://:3002` or `http://localhost:3002`). + ## Try the mobile app +### Install the Mobile App +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. ## 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. + +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/). + +You can import your codes from other authenticator providers to Ente Auth. Check out the [migration guide](/auth/migration/) for more information. + ## Queries? diff --git a/docs/docs/self-hosting/install/from-source.md b/docs/docs/self-hosting/install/from-source.md index 6b2c168ab2..b3f1ebc5d2 100644 --- a/docs/docs/self-hosting/install/from-source.md +++ b/docs/docs/self-hosting/install/from-source.md @@ -7,7 +7,8 @@ description: Getting started self hosting Ente Photos and/or Ente Auth ## Installing Docker -Refer to [How to install Docker from the APT repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) +Refer to +[How to install Docker from the APT repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) for detailed instructions. ## Start the server diff --git a/docs/docs/self-hosting/install/quickstart.md b/docs/docs/self-hosting/install/quickstart.md index 00d3de1373..e7311f5cc7 100644 --- a/docs/docs/self-hosting/install/quickstart.md +++ b/docs/docs/self-hosting/install/quickstart.md @@ -5,11 +5,13 @@ description: Self-hosting Ente with quickstart script # Quickstart -We provide a quickstart script which can be used for self-hosting Ente on your machine. +We provide a quickstart script which can be used for self-hosting Ente on your +machine. ## Requirements -Check out the [requirements](/self-hosting/install/requirements) page to get started. +Check out the [requirements](/self-hosting/install/requirements) page to get +started. ## Getting started @@ -20,7 +22,8 @@ sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/q ``` The above `curl` command pulls the Docker image, creates a directory `my-ente` -in the current working directory, prompts to start the cluster and starts all the containers required to run Ente. +in the current working directory, prompts to start the cluster and starts all +the containers required to run Ente. ![quickstart](/quickstart.png) diff --git a/docs/docs/self-hosting/install/requirements.md b/docs/docs/self-hosting/install/requirements.md index 07d237751d..95b4699e8f 100644 --- a/docs/docs/self-hosting/install/requirements.md +++ b/docs/docs/self-hosting/install/requirements.md @@ -23,9 +23,10 @@ experience with Docker and difficulty with troubleshooting and assistance. ### Docker Required for running Ente's server, web application and dependent services -(database and object storage). Ente also requires **Docker Compose plugin** to be installed. +(database and object storage). Ente also requires **Docker Compose plugin** to +be installed. -> [!NOTE] -> Ente requires **Docker Compose version 2.25 or higher**. -> -> Furthermore, Ente uses the command `docker compose`, `docker-compose` is no longer supported. \ No newline at end of file +> [!NOTE] Ente requires **Docker Compose version 2.25 or higher**. +> +> Furthermore, Ente uses the command `docker compose`, `docker-compose` is no +> longer supported. diff --git a/docs/docs/self-hosting/install/standalone-ente.md b/docs/docs/self-hosting/install/standalone-ente.md index 56c4f180d6..adaf444594 100644 --- a/docs/docs/self-hosting/install/standalone-ente.md +++ b/docs/docs/self-hosting/install/standalone-ente.md @@ -17,7 +17,7 @@ development. brew install go ``` - For Debian/Ubuntu-based distros - ``` sh + ```sh sudo apt update && sudo apt upgrade sudo apt install golang-go ``` @@ -33,7 +33,7 @@ Alternatively, you can also download the latest binaries from brew install libsodium ``` - For Debian/Ubuntu-based distros - ``` sh + ```sh sudo apt install postgresql sudo apt install libsodium23 libsodium-dev ``` @@ -47,7 +47,7 @@ Install `pkg-config` brew install pkg-config ``` - For Debian/Ubuntu-based distros - ``` sh + ```sh sudo apt install pkg-config ``` @@ -63,9 +63,9 @@ Depending on the operating system type, the path for postgres binary or configuration file might be different, please check if the command keeps failing for you. -Ideally, if you are on a Linux system with `systemd` as the initialization ("init") system. You can also -start postgres as a systemd service. After Installation execute the following -commands: +Ideally, if you are on a Linux system with `systemd` as the initialization +("init") system. You can also start postgres as a systemd service. After +Installation execute the following commands: ```sh sudo systemctl enable postgresql diff --git a/docs/docs/self-hosting/troubleshooting/docker.md b/docs/docs/self-hosting/troubleshooting/docker.md index 158b8a63fc..840504ca65 100644 --- a/docs/docs/self-hosting/troubleshooting/docker.md +++ b/docs/docs/self-hosting/troubleshooting/docker.md @@ -138,7 +138,10 @@ afresh for it. ## MinIO provisioning error -If you have used our quickstart script for self-hosting Ente (new users will be unaffected) and are using the default MinIO container for object storage, you may run into issues while starting the cluster after pulling latest images with provisioning MinIO and creating buckets. +If you have used our quickstart script for self-hosting Ente (new users will be +unaffected) and are using the default MinIO container for object storage, you +may run into issues while starting the cluster after pulling latest images with +provisioning MinIO and creating buckets. You may encounter similar logs while trying to start the cluster: @@ -148,14 +151,18 @@ my-ente-minio-1 -> | Waiting for minio... my-ente-minio-1 -> | Waiting for minio... ``` -MinIO has deprecated the `mc config` command in favor of `mc alias set` resulting in failure in execution of the command for creating bucket using `post_start` hook. +MinIO has deprecated the `mc config` command in favor of `mc alias set` +resulting in failure in execution of the command for creating bucket using +`post_start` hook. -This can be resolved by changing `mc config host h0 add http://minio:3200 $minio_user $minio_pass` to `mc alias set h0 http://minio:3200 $minio_user $minio_pass` +This can be resolved by changing +`mc config host h0 add http://minio:3200 $minio_user $minio_pass` to +`mc alias set h0 http://minio:3200 $minio_user $minio_pass` Thus the updated `post_start` will look as follows for `minio` service: -``` yaml - minio: +```yaml + minio: ... post_start: - command: | @@ -174,4 +181,4 @@ Thus the updated `post_start` will look as follows for `minio` service: mc mb -p wasabi-eu-central-2-v3 mc mb -p scw-eu-fr-v3 ' -``` \ No newline at end of file +```