diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index d1b8c37e3f..5148296f11 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -207,22 +207,22 @@ export const sidebar = [ text: "Migration", collapsed: true, items: [ - { text: "Introduction", link: "/auth/migration-guides/" }, + { text: "Introduction", link: "/auth/migration/" }, { text: "From Authy", - link: "/auth/migration-guides/authy/", + link: "/auth/migration/authy/", }, { text: "From Steam", - link: "/auth/migration-guides/steam/", + link: "/auth/migration/steam/", }, { text: "From others", - link: "/auth/migration-guides/import", + link: "/auth/migration/import", }, { text: "Exporting your data", - link: "/auth/migration-guides/export", + link: "/auth/migration/export", }, ], }, @@ -267,8 +267,12 @@ export const sidebar = [ link: "/self-hosting/install/without-docker", }, { - text: "Configuration Variables", - link: "/self-hosting/install/configuration-variables", + text: "Environment Variable and Defaults", + link: "/self-hosting/install/env-var", + }, + { + text: "Configuration File", + link: "/self-hosting/install/config-file", }, { text: "Post Installation", @@ -294,7 +298,7 @@ export const sidebar = [ }, { text: "Configuring CLI for your instance", - link: "/self-hosting/guides/selfhost-cli", + link: "/self-hosting/administration/selfhost-cli", }, ], diff --git a/docs/docs/auth/features/index.md b/docs/docs/auth/features/index.md index 36d43392fa..6032dc1c26 100644 --- a/docs/docs/auth/features/index.md +++ b/docs/docs/auth/features/index.md @@ -106,7 +106,7 @@ Ente Auth offers various import and export options for your codes. - **Import:** Import codes from various other authentication apps. For detailed instructions, refer to the -[migration guides](../migration-guides/). +[migration guides](../migration/). ### Deduplicate codes diff --git a/docs/docs/auth/migration-guides/authy/index.md b/docs/docs/auth/migration/authy/index.md similarity index 100% rename from docs/docs/auth/migration-guides/authy/index.md rename to docs/docs/auth/migration/authy/index.md diff --git a/docs/docs/auth/migration-guides/export.md b/docs/docs/auth/migration/export.md similarity index 100% rename from docs/docs/auth/migration-guides/export.md rename to docs/docs/auth/migration/export.md diff --git a/docs/docs/auth/migration-guides/import.md b/docs/docs/auth/migration/import.md similarity index 100% rename from docs/docs/auth/migration-guides/import.md rename to docs/docs/auth/migration/import.md diff --git a/docs/docs/auth/migration-guides/index.md b/docs/docs/auth/migration/index.md similarity index 100% rename from docs/docs/auth/migration-guides/index.md rename to docs/docs/auth/migration/index.md diff --git a/docs/docs/auth/migration-guides/steam/index.md b/docs/docs/auth/migration/steam/index.md similarity index 100% rename from docs/docs/auth/migration-guides/steam/index.md rename to docs/docs/auth/migration/steam/index.md diff --git a/docs/docs/self-hosting/administration/configuring-s3.md b/docs/docs/self-hosting/administration/configuring-s3.md index 0ac0657228..e9cb3ebb26 100644 --- a/docs/docs/self-hosting/administration/configuring-s3.md +++ b/docs/docs/self-hosting/administration/configuring-s3.md @@ -11,14 +11,11 @@ description: > [!IMPORTANT] > -> As of now, replication works only if all the 3 storage type needs are -> fulfilled (1 hot, 1 cold and 1 glacier storage). +> As of now, replication works only if all the 3 storage buckets are configured (2 hot and 1 cold storage). > > 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 -[replication](https://ente.io/reliability/). +> [discussion](https://github.com/ente-io/ente/discussions/3167#discussioncomment-10585970) +> and our article on ensuring [reliability](https://ente.io/reliability/). In a self hosted Ente instance replication is turned off by default. When replication is turned off, only the first bucket (`b2-eu-cen`) is used, and the diff --git a/docs/docs/self-hosting/administration/museum.md b/docs/docs/self-hosting/administration/museum.md index cb5263104f..998e7ad4b6 100644 --- a/docs/docs/self-hosting/administration/museum.md +++ b/docs/docs/self-hosting/administration/museum.md @@ -29,7 +29,7 @@ MinIO buckets. If you wish to use an external S3 provider, you can edit the configuration with your provider's credentials, and set `are_local_buckets` to `false`. -Check out [Configuring S3](/self-hosting/guides/configuring-s3.md) to understand +Check out [Configuring S3] to understand more about configuring S3 buckets. MinIO uses the port `3200` for API Endpoints and their web app runs over @@ -38,7 +38,7 @@ browser. If you face any issues related to uploads then checkout [Troubleshooting bucket CORS](/self-hosting/troubleshooting/bucket-cors) and -[Frequently encountered S3 errors](/self-hosting/guides/configuring-s3#frequently-encountered-errors). +[Frequently encountered S3 errors]. ## Web apps @@ -70,8 +70,4 @@ stop all the Docker containers with `docker compose down` and restart them with Similarly, you can use the default [`local.yaml`](https://github.com/ente-io/ente/tree/main/server/configurations/local.yaml) as a reference for building a functioning `museum.yaml` for many other -functionalities like SMTP, Discord notifications, Hardcoded-OTTs, etc. - -## References - -- [Environment variables and ports](/self-hosting/faq/environment) +functionalities like SMTP, Discord notifications, Hardcoded-OTTs, etc. \ No newline at end of file diff --git a/docs/docs/self-hosting/guides/admin.md b/docs/docs/self-hosting/guides/admin.md index 10d05fb4d0..41732e22f5 100644 --- a/docs/docs/self-hosting/guides/admin.md +++ b/docs/docs/self-hosting/guides/admin.md @@ -85,4 +85,4 @@ using the CLI. ## Backups -See this [FAQ](/self-hosting/faq/backup). +See this [document](/self-hosting/administration/backup). diff --git a/docs/docs/self-hosting/guides/index.md b/docs/docs/self-hosting/guides/index.md index 22b28107d4..3925b7e185 100644 --- a/docs/docs/self-hosting/guides/index.md +++ b/docs/docs/self-hosting/guides/index.md @@ -11,13 +11,13 @@ walkthroughs, tutorials and other FAQ pages in this directory. See the sidebar for existing guides. In particular: - If you're just looking to get started, see - [configure custom server](custom-server/). + [configure custom server]. - For various admin related tasks, e.g. increasing the storage quota on your self hosted instance, see [administering your custom server](admin). - For configuring your S3 buckets to get the object storage to work from your mobile device or for fixing an upload errors, see - [configuring S3](configuring-s3). There is also a longer - [community contributed guide](external-s3) for a more self hosted setup of + configuring S3. There is also a longer + community contributed guide for a more self hosted setup of both the server and web app using external S3 buckets for object storage. diff --git a/docs/docs/self-hosting/install/configuration-variables.md b/docs/docs/self-hosting/install/env-var.md similarity index 100% rename from docs/docs/self-hosting/install/configuration-variables.md rename to docs/docs/self-hosting/install/env-var.md