diff --git a/docs/docs/photos/faq/general.md b/docs/docs/photos/faq/general.md index 040a7e1bfa..e03a6ebc9b 100644 --- a/docs/docs/photos/faq/general.md +++ b/docs/docs/photos/faq/general.md @@ -67,7 +67,7 @@ reliable as any one can be. If you would like to fund the development of this project, please consider [subscribing](https://ente.io/download). -## How do I pronounce ente? +## How do I pronounce Ente? It's like cafe 😊. kaf-_ay_. en-_tay_. diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index a74b70882c..0bebcca64c 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -7,8 +7,8 @@ description: Getting started with self-hosting Ente 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 +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 @@ -35,15 +35,19 @@ 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. ::: +::: info + +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 Open Ente Photos web app at `http://:3000` (or -`http://localhost:3000` if using on same local machine). Select **Don't have an -account?** to create a new user. +`http://localhost:3000` if using on same local machine). +Select **Don't have an account?** to create a new user. Follow the prompts to sign up. diff --git a/docs/docs/self-hosting/installation/compose.md b/docs/docs/self-hosting/installation/compose.md index b1e76b22e6..fb31639ec4 100644 --- a/docs/docs/self-hosting/installation/compose.md +++ b/docs/docs/self-hosting/installation/compose.md @@ -45,6 +45,25 @@ cp example.yaml museum.yaml Change the values present in `.env` file along with `museum.yaml` file accordingly. +::: tip + +Make sure to enter the correct values for the database and object storage. + +You should consider generating values for JWT and encryption keys for emails if +you intend to use for long-term needs. + +You can do by running the following command inside `ente/server`, assuming you +cloned the repository to `ente`: + +```shell +# Change into the ente/server +cd ente/server +# Generate secrets +go run tools/gen-random-keys/main.go +``` + +::: + ## Step 3: Start the cluster Start the cluster by running the following command: diff --git a/docs/docs/self-hosting/installation/manual.md b/docs/docs/self-hosting/installation/manual.md index eead12222e..b174feab69 100644 --- a/docs/docs/self-hosting/installation/manual.md +++ b/docs/docs/self-hosting/installation/manual.md @@ -92,9 +92,9 @@ git clone https://github.com/ente-io/ente 2. Build the server. The server binary should be available as `./main` relative to `server` directory - ``` shell - go build cmd/museum/main.go - ``` + ```shell + go build cmd/museum/main.go + ``` 3. Create `museum.yaml` file inside `server` for configuring the needed variables. You can copy the templated configuration file for editing with @@ -104,6 +104,25 @@ git clone https://github.com/ente-io/ente cp config/example.yaml ./museum.yaml ``` + ::: tip + + Make sure to enter the correct values for the database and object storage. + + You should consider generating values for JWT and encryption keys for emails + if you intend to use for long-term needs. + + You can do by running the following command inside `ente/server`, assuming + you cloned the repository to `ente`: + + ```shell + # Change into the ente/server + cd ente/server + # Generate secrets + go run tools/gen-random-keys/main.go + ``` + + ::: + 4. Run the server ```shell diff --git a/docs/docs/self-hosting/installation/post-install/index.md b/docs/docs/self-hosting/installation/post-install/index.md index cfd8f6db09..b6ebd19b98 100644 --- a/docs/docs/self-hosting/installation/post-install/index.md +++ b/docs/docs/self-hosting/installation/post-install/index.md @@ -159,10 +159,9 @@ apps](web-dev-settings.png){width=400px} ## Step 7: Configure Ente CLI You can download Ente CLI from -[here](https://github.com/ente-io/ente/releases?q=tag%3Acli) +[here](https://github.com/ente-io/ente/releases?q=tag%3Acli). -Check our [documentation](/self-hosting/administration/cli) on how to use Ente -CLI for managing self-hosted instances. +Check our [documentation](/self-hosting/administration/cli) on how to use Ente CLI for managing self-hosted instances. ::: info For upgrading