TerribleDev/ente
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] update quickstart documentation

Browse Source
This commit is contained in:
Keerthana
2025-06-13 03:54:53 +05:30
parent bab661914d
commit 898c0e31a1
2 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/self-hosting/index.md
View File

@@ -22,9 +22,9 @@ on the client. It performs well on small cloud instances, old laptops, and even
#### Operating System
Any Linux or \*nix operating system, Ubuntu or Debian is recommended
to have a good Docker experience. Non-Linux operating systems tend to provide
poor experience with Docker and difficulty with troubleshooting and assistance.
Any Linux or \*nix operating system, Ubuntu or Debian is recommended to have a
good Docker experience. Non-Linux operating systems tend to provide poor
experience with Docker and difficulty with troubleshooting and assistance.
#### Docker
@@ -40,7 +40,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 and starts all containers required to run Ente.
in the current working directory and prompts to start the cluster, which upon
entering `y`, starts all the containers required to run Ente.
![quickstart](/quickstart.png)

8
server/docs/quickstart.md
View File

@@ -16,9 +16,15 @@ sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/q
>
> If you don't want to run via curl, you can alternatively download
> [quickstart.sh](https://github.com/ente-io/ente/blob/main/server/quickstart.sh),
> `chmod +x` it and then run it with `./quickstart.sh`.
> make it executable and run the script.
>
> ``` shell
> curl -o quickstart.sh https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh
> chmod +x quickstart.sh
> ./quickstart.sh
If prompted to start the cluster, enter `y` if you wish to start the Docker compose cluster.
After the Docker compose cluster starts, you can open the Ente web app at
http://localhost:3000.