[docs] refactor standalone and from source docs

2025-07-12 12:56:45 +05:30
parent b580d6ce35
commit f06403adc7
3 changed files with 52 additions and 52 deletions
--- a/docs/docs/self-hosting/install/config.md
+++ b/docs/docs/self-hosting/install/config.md
@@ -26,18 +26,23 @@ Here's the list of environment variables that need to be configured:

 ## Config File

+Ente's server, Museum, uses a configuration file
+
 ## Default Configuration

 ### Ports

-The below format is according to how ports are mapped in Docker when using quickstart script.
-The mapping is of the format `- <host-port>:<container-port>` in `ports`.
+The below format is according to how ports are mapped in Docker when using
+quickstart script. The mapping is of the format `- <host-port>:<container-port>`
+in `ports`.

-| Service                            | Type   | Host Port | Container Port |
-| ---------------------------------- | ------ | --------- | -------------- |
-| Museum                             | Server | 8080      | 8080           |
-| Ente Photos                        | Web    | 3000      | 3000           |
-| Ente Accounts                      | Web    | 3001      | 3001           |
-| Ente Albums                        | Web    | 3002      | 3002           |
-| [Ente Auth](https://ente.io/auth/) | Web    | 3003      | 3003           |
-| [Ente Cast](http://ente.io/cast)   | Web    | 3004      | 3004           |
+| Service                            | Type     | Host Port | Container Port |
+| ---------------------------------- | -------- | --------- | -------------- |
+| Museum                             | Server   | 8080      | 8080           |
+| Ente Photos                        | Web      | 3000      | 3000           |
+| Ente Accounts                      | Web      | 3001      | 3001           |
+| Ente Albums                        | Web      | 3002      | 3002           |
+| [Ente Auth](https://ente.io/auth/) | Web      | 3003      | 3003           |
+| [Ente Cast](http://ente.io/cast)   | Web      | 3004      | 3004           |
+| MinIO                              | S3       | 3200      | 3200           |
+| PostgreSQL                         | Database |           | 5432           |
--- a/docs/docs/self-hosting/install/from-source.md
+++ b/docs/docs/self-hosting/install/from-source.md
@@ -5,16 +5,9 @@ description: Getting started self hosting Ente Photos and/or Ente Auth

 # Ente from Source

-> [!WARNING] NOTE
-> The below documentation will cover instructions about
-> self-hosting the web app manually. If you want to deploy Ente hassle free, use
-> the [one line](https://ente.io/blog/self-hosting-quickstart/) command to setup
-> Ente. This guide might be deprecated in the near future.
-
 ## 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
@@ -187,5 +180,3 @@ Albums Family and Cast in your `museum.yaml` configuration file. Checkout
 [`local.yaml`](https://github.com/ente-io/ente/blob/543411254b2bb55bd00a0e515dcafa12d12d3b35/server/configurations/local.yaml#L76-L89)
 to configure the endpoints. Make sure to setup up your DNS Records accordingly
 to the similar URL's you set up in `museum.yaml`.
-
-Next part is to configure the web server.
--- a/docs/docs/self-hosting/install/standalone-ente.md
+++ b/docs/docs/self-hosting/install/standalone-ente.md
@@ -10,56 +10,60 @@ description: Installing and setting up Ente without Docker
 First, start by installing all the dependencies to get your machine ready for
 development.

-```sh
-# For MacOS
-brew tap homebrew/core
-brew update
-brew install go
-
-# For Ubuntu based distros
-sudo apt update && sudo apt upgrade
-sudo apt install golang-go
-```
+- For macOS
+    ```sh
+    brew tap homebrew/core
+    brew update
+    brew install go
+    ```
+- For Debian/Ubuntu-based distros
+    ``` sh
+    sudo apt update && sudo apt upgrade
+    sudo apt install golang-go
+    ```

 Alternatively, you can also download the latest binaries from
 ['All Release'](https://go.dev/dl/) page from the official website.

-```sh
-brew install postgres@15
-# Link the postgres keg
-brew link postgresql@15
-
-brew install libsodium
-
-# For Ubuntu based distros
-sudo apt install postgresql
-sudo apt install libsodium23 libsodium-dev
-```
+- For macOS
+    ```sh
+    brew install postgres@15
+    # Link the postgres keg
+    brew link postgresql@15
+    brew install libsodium
+    ```
+- For Debian/Ubuntu-based distros
+    ``` sh
+    sudo apt install postgresql
+    sudo apt install libsodium23 libsodium-dev
+    ```

 The package `libsodium23` might be installed already in some cases.

-Installing pkg-config
+Install `pkg-config`

-```sh
-brew install pkg-config
-
-# For Ubuntu based distros
-sudo apt install pkg-config
-```
+- For macOS
+    ```sh
+    brew install pkg-config
+    ```
+- For Debian/Ubuntu-based distros
+    ``` sh
+    sudo apt install pkg-config
+    ```

 ## Starting Postgres

-### With pg_ctl
+### With `pg_ctl`

 ```sh
 pg_ctl -D /usr/local/var/postgres -l logfile start
 ```

-Dependeing on the Operating System type the path for postgres binary or
+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 init. You can also
+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:

@@ -71,7 +75,7 @@ sudo systemctl daemon-reload && sudo systemctl start postgresql
 ### Create user

 ```sh
-createuser -s postgres
+sudo useradd postgres
 ```

 ## Start Museum