diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index de77ceda75..bb0396d4a3 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -25,14 +25,13 @@ sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/q > [!TIP] > -> For more details about what this does, or if you would rather do the same -> steps manually, see -> [the quickstart README](https://github.com/ente-io/ente/blob/main/server/quickstart/README.md). +> For more details about what this does, see [the quickstart +> README](https://github.com/ente-io/ente/blob/main/server/docs/quickstart.md). That's about it. If you open http://localhost:3000, you will be able to create an account on a Ente Photos web app running on your machine, and this web app will be connecting to the server running on your local machine at -`localhost:8080`. +`localhost:8080`. The verification code will be shown in the server logs. For the mobile or desktop apps, you don't even need to build, and can install normal Ente apps and configure them to use your diff --git a/server/README.md b/server/README.md index 7216e8c0f9..4d8a173c88 100644 --- a/server/README.md +++ b/server/README.md @@ -41,7 +41,7 @@ This time you'll see the updated message. > > You can also use pre-built Docker images to directly start a cluster without > needing to clone this repository - see -> [quickstart/README.md](quickstart/README.md). +> [docs/quickstart.md](docs/quickstart.md). For more details about how to get museum up and running, see [RUNNING.md](RUNNING.md). diff --git a/server/RUNNING.md b/server/RUNNING.md index 0c5224aa1e..0416da2586 100644 --- a/server/RUNNING.md +++ b/server/RUNNING.md @@ -1,8 +1,8 @@ # Running Museum -You can run a Docker compose cluster containing museum and the essential -auxiliary services it requires (database and object storage). This is the -easiest and simplest way to get started, and also provides an isolated +You can run a Docker compose cluster containing museum, the web app, and the +essential auxiliary services it requires (database and object storage). This is +the easiest and simplest way to get started, and also provides an isolated environment that doesn't clutter your machine. You can also run museum directly on your machine if you wish - it is a single @@ -17,17 +17,13 @@ also outlines configuration. - [Run without Docker](#running-without-docker) - [Configuration](#configuration) -If your mobile app is able to connect to your self hosted instance but is not -able to view or upload images, see -[help.ente.io/self-hosting/guides/configuring-s3](https://help.ente.io/self-hosting/guides/configuring-s3). - ## Run using pre-built Docker images ```sh sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh)" ``` -For more details, see [quickstart/README.md](quickstart/README.md). +For more details, see [docs/quickstart.md](docs/quickstart.md). ## Build and run using Docker @@ -230,3 +226,9 @@ a config file later on. The keys and values supported by this configuration file are documented in [configurations/local.yaml](configurations/local.yaml). + +> [!TIP] +> +> If your mobile app is able to connect to your self hosted instance but is not +able to view or upload images, see +[help.ente.io/self-hosting/guides/configuring-s3](https://help.ente.io/self-hosting/guides/configuring-s3). diff --git a/server/configurations/local.yaml b/server/configurations/local.yaml index 5bac3408e7..8463dfd877 100644 --- a/server/configurations/local.yaml +++ b/server/configurations/local.yaml @@ -201,10 +201,10 @@ s3: # provided here. But if you're really going to be using museum, please generate # new keys. You can use `go run tools/gen-random-keys/main.go` for that. # -# If you used the quickstart.sh script to prepare your compose.yaml, it would -# have already generated new randomly generated values for you in your -# compose.yaml, in the config section. Those will override these defaults; those -# are the values for your instance would use, and what you need to backup. +# If you used the quickstart.sh script to prepare your compose.yaml, it would've +# already generated new randomly credentials for you in your `museum.yaml`. +# Those will override these defaults; those are the values for your instance +# would use, and what you need to backup. key: encryption: yvmG/RnzKrbCb9L3mgsmoxXr9H7i2Z4qlbT0mL3ln4w= hash: KXYiG07wC7GIgvCSdg+WmyWdXDAn6XKYJtp/wkEU7x573+byBRAYtpTP0wwvi8i/4l37uicX1dVTUzwH3sLZyw== diff --git a/server/docs/docker.md b/server/docs/docker.md index 9be7aa304c..6ccfdc01cb 100644 --- a/server/docs/docker.md +++ b/server/docs/docker.md @@ -1 +1 @@ -Moved to [quickstart/README.md](../quickstart/README.md). +Moved to [quickstart.md](./quickstart.md).