beenull/ente
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

yarn pretty

Browse source
This commit is contained in:
Manav Rathi 2024-03-11 10:31:07 +05:30
parent 8f384247ba
commit e1e0c45d88
17 changed files with 62 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -13,7 +13,6 @@ changes in a few minutes after your pull request is merged.
## Running locally ## Running locally
The above workflow is great since it doesn't require you to setup anything on The above workflow is great since it doesn't require you to setup anything on
your local machine. But if you plan on contributing frequently, you might find your local machine. But if you plan on contributing frequently, you might find
it easier to run things locally. it easier to run things locally.

2
docs/docs/.vitepress/config.ts
View file

@ -7,7 +7,7 @@ export default defineConfig({
description: "Documentation and help for Ente's products", description: "Documentation and help for Ente's products",
head: [["link", { rel: "icon", type: "image/png", href: "/favicon.png" }]], head: [["link", { rel: "icon", type: "image/png", href: "/favicon.png" }]],
cleanUrls: true, cleanUrls: true,
ignoreDeadLinks: 'localhostLinks', ignoreDeadLinks: "localhostLinks",
themeConfig: { themeConfig: {
// We use the default theme (with some CSS color overrides). This // We use the default theme (with some CSS color overrides). This
// themeConfig block can be used to further customize the default theme. // themeConfig block can be used to further customize the default theme.

10
docs/docs/.vitepress/sidebar.ts
View file

@ -84,8 +84,14 @@ export const sidebar = [
text: "Guides", text: "Guides",
items: [ items: [
{ text: "Introduction", link: "/self-hosting/guides/" }, { text: "Introduction", link: "/self-hosting/guides/" },
{ text: "Configure custom server", link: "/self-hosting/guides/custom-server/" }, {
{ text: "Mobile build", link: "/self-hosting/guides/mobile-build" }, text: "Configure custom server",
link: "/self-hosting/guides/custom-server/",
},
{
text: "Mobile build",
link: "/self-hosting/guides/mobile-build",
},
{ {
text: "System requirements", text: "System requirements",
link: "/self-hosting/guides/system-requirements", link: "/self-hosting/guides/system-requirements",

8
docs/docs/about/index.md
View file

@ -11,9 +11,9 @@ Ente is a end-to-end encrypted platform for privately, reliably, and securely
storing your data on the cloud. On top of this platform, Ente offers two storing your data on the cloud. On top of this platform, Ente offers two
products: products:
* **Ente Photos** - An alternative to Google Photos and Apple Photos - **Ente Photos** - An alternative to Google Photos and Apple Photos
* **Ente Auth** - A free 2FA alternative to Authy - **Ente Auth** - A free 2FA alternative to Authy
Both these apps are available for all desktop (Linux, Mac, Windows) and mobile Both these apps are available for all desktop (Linux, Mac, Windows) and mobile
(Android, iOS and F-Droid) platforms. They also work directly in your web (Android, iOS and F-Droid) platforms. They also work directly in your web
@ -60,8 +60,8 @@ how we're building Ente, you can read our [blog](https://ente.io/blog) (or
subscribe to it via [RSS](https://ente.io/blog/rss.xml)) subscribe to it via [RSS](https://ente.io/blog/rss.xml))
To suggest new features and/or offer your perspective on how we should design To suggest new features and/or offer your perspective on how we should design
planned and upcoming features, use our [GitHub planned and upcoming features, use our
discussions](https://github.com/ente-io/ente/discussions) [GitHub discussions](https://github.com/ente-io/ente/discussions)
Or if you'd just like to hang out, join our Or if you'd just like to hang out, join our
[Discord](https://discord.gg/z2YVKkycX3), follow us on [Discord](https://discord.gg/z2YVKkycX3), follow us on

4
docs/docs/auth/migration-guides/index.md
View file

@ -1,6 +1,8 @@
--- ---
title: Migrating to Ente Auth title: Migrating to Ente Auth
description: Guides for migrating your existing 2FA tokens from other products into Ente Auth description:
Guides for migrating your existing 2FA tokens from other products into Ente
Auth
--- ---
# Migrating to Ente Auth # Migrating to Ente Auth

5
docs/docs/index.md
View file

@ -4,9 +4,8 @@ title: Home
# Welcome! # Welcome!
This site contains documentation and help for Ente Photos and Ente Auth. This site contains documentation and help for Ente Photos and Ente Auth. It
It describes various features, and also offers various troubleshooting describes various features, and also offers various troubleshooting suggestions.
suggestions.
Use the **sidebar** menu to navigate to information about the product (Photos or Use the **sidebar** menu to navigate to information about the product (Photos or
Auth) you'd like to know more about. Or use the **search** at the top to try and Auth) you'd like to know more about. Or use the **search** at the top to try and

10
docs/docs/photos/features/cast/index.md
View file

@ -39,11 +39,11 @@ Chromecast TVs or other Internet-connected large screen devices.
</div> </div>
On Google Chrome and other Chromium browsers, you will see a button labeled On Google Chrome and other Chromium browsers, you will see a button labeled
"Auto Pair". This option will prompt you to select a Chromecast supported device "Auto Pair". This option will prompt you to select a Chromecast supported
on your local network. Note: this option requires connecting to Google servers device on your local network. Note: this option requires connecting to
to load necessary dependencies. This option does not transmit any sensitive data Google servers to load necessary dependencies. This option does not transmit
through Google servers, such as your photos. Once your Chromecast device is any sensitive data through Google servers, such as your photos. Once your
connected, you're all set. Chromecast device is connected, you're all set.
On all browsers, you'll see the option to "Pair with PIN". This option works On all browsers, you'll see the option to "Pair with PIN". This option works
with all devices, Chromecast-enabled or not. You'll be required to load up with all devices, Chromecast-enabled or not. You'll be required to load up

3
docs/docs/photos/features/family-plans.md
View file

@ -1,6 +1,7 @@
--- ---
title: Family plans title: Family plans
description: Share your Ente Photos plan with your family members with no extra cost description:
Share your Ente Photos plan with your family members with no extra cost
--- ---
# Family plans # Family plans

4
docs/docs/photos/features/public-links.md
View file

@ -1,6 +1,8 @@
--- ---
title: Public links title: Public links
description: Share photos with your friends and family without them needing to install Ente Photos description:
Share photos with your friends and family without them needing to install
Ente Photos
--- ---
# Public Links # Public Links

4
docs/docs/photos/features/referrals.md
View file

@ -1,6 +1,8 @@
--- ---
title: Referral plan title: Referral plan
description: Earn and expand your storage by referring Ente Photos to your friends and family description:
Earn and expand your storage by referring Ente Photos to your friends and
family
--- ---
# Referral plan # Referral plan

6
docs/docs/photos/features/sharing.md
View file

@ -1,6 +1,7 @@
--- ---
title: Sharing title: Sharing
description: Ente allows you to share albums and collaborate with your loved ones description:
Ente allows you to share albums and collaborate with your loved ones
--- ---
# Sharing # Sharing
@ -36,4 +37,5 @@ same album - someone can be added as a `Collaborator`, while someone else as a
If you wish to collect photos from folks who are not Ente, you can do so with If you wish to collect photos from folks who are not Ente, you can do so with
our Links. Simply tick the box that says "Allow uploads", and anyone who has our Links. Simply tick the box that says "Allow uploads", and anyone who has
access to the link will be able to add photos to your album. [Read more](https://ente.io/blog/collect-photos/) access to the link will be able to add photos to your album.
[Read more](https://ente.io/blog/collect-photos/)

3
docs/docs/photos/troubleshooting/files-not-uploading.md
View file

@ -1,6 +1,7 @@
--- ---
title: Files not uploading title: Files not uploading
description: Troubleshooting when files are not uploading from your Ente Photos app description:
Troubleshooting when files are not uploading from your Ente Photos app
--- ---
# Files not uploading # Files not uploading

4
docs/docs/self-hosting/faq/otp.md
View file

@ -8,9 +8,9 @@ description: Getting the OTP for a self host Ente
The self-hosted Ente by default does not send out emails, so you can pick the The self-hosted Ente by default does not send out emails, so you can pick the
verification code by: verification code by:
* Getting it from the server logs, or - Getting it from the server logs, or
* Reading it from the DB (otts table) - Reading it from the DB (otts table)
You can also set pre-defined hardcoded OTTs for certain users when running You can also set pre-defined hardcoded OTTs for certain users when running
locally by creating a `museum.yaml` and adding the `internal.hardcoded-ott` locally by creating a `museum.yaml` and adding the `internal.hardcoded-ott`

10
docs/docs/self-hosting/guides/mobile-build.md
View file

@ -1,13 +1,15 @@
--- ---
title: Building mobile apps title: Building mobile apps
description: Connecting to your custom self-hosted server when building the Ente mobile apps from source description:
Connecting to your custom self-hosted server when building the Ente mobile
apps from source
--- ---
# Mobile: Build and connect to self-hosted server # Mobile: Build and connect to self-hosted server
The up to date instructions to build the mobile apps are in the [Ente The up to date instructions to build the mobile apps are in the
Photos](https://github.com/ente-io/ente/tree/main/mobile#readme) and [Ente [Ente Photos](https://github.com/ente-io/ente/tree/main/mobile#readme) and
Auth](https://github.com/ente-io/ente/tree/main/auth#readme) READMEs. When [Ente Auth](https://github.com/ente-io/ente/tree/main/auth#readme) READMEs. When
building or running, you can use the building or running, you can use the
```sh ```sh

4
docs/docs/self-hosting/guides/system-requirements.md
View file

@ -10,5 +10,5 @@ very light weight - it's just a single go binary, and it doesn't do any server
side ML, so I feel it should be able to run on anything reasonable. side ML, so I feel it should be able to run on anything reasonable.
We've used the server quite easily on small cloud instances, old laptops etc. A We've used the server quite easily on small cloud instances, old laptops etc. A
community member also reported being able to run the server on [very low-end community member also reported being able to run the server on
embedded devices](https://github.com/ente-io/ente/discussions/594). [very low-end embedded devices](https://github.com/ente-io/ente/discussions/594).

28
docs/docs/self-hosting/index.md
View file

@ -10,9 +10,9 @@ the same code we use for our own cloud service.
> [!TIP] > [!TIP]
> >
> To get some context, you might find our [blog > To get some context, you might find our
> post](https://ente.io/blog/open-sourcing-our-server/) announcing the open > [blog post](https://ente.io/blog/open-sourcing-our-server/) announcing the
> sourcing of our server useful. > open sourcing of our server useful.
## Getting started ## Getting started
@ -39,24 +39,24 @@ will be connecting to the server running on your local machine at
localhost:8080. localhost:8080.
For the mobile apps, you don't even need to build, and can install normal Ente For the mobile apps, you don't even need to build, and can install normal Ente
apps and configure them to use your [custom self-hosted apps and configure them to use your
server](guides/custom-server). [custom self-hosted server](guides/custom-server).
> If you want to build from source, see the instructions > If you want to build from source, see the instructions
[here](guides/mobile-build). > [here](guides/mobile-build).
## Next steps ## Next steps
* More details about the server are in its - More details about the server are in its
[README](https://github.com/ente-io/ente/tree/main/server#readme) [README](https://github.com/ente-io/ente/tree/main/server#readme)
* More details about running the server (with or without Docker) are in - More details about running the server (with or without Docker) are in
[RUNNING](https://github.com/ente-io/ente/blob/main/server/RUNNING.md) [RUNNING](https://github.com/ente-io/ente/blob/main/server/RUNNING.md)
* If you have questions around self-hosting that are not answered in any of the - If you have questions around self-hosting that are not answered in any of
existing documentation, you can ask in our [GitHub the existing documentation, you can ask in our
Discussions](https://github.com/ente-io/ente/discussions). **Please remember [GitHub Discussions](https://github.com/ente-io/ente/discussions). **Please
to search first if the query has been already asked and answered.** remember to search first if the query has been already asked and answered.**
## Contributing! ## Contributing!

2
docs/docs/self-hosting/troubleshooting/yarn.md
View file

@ -7,4 +7,4 @@ description: Fixing yarn install errors when trying to self host Ente
If your `yarn install` is failing, make sure you are using Yarn Classic If your `yarn install` is failing, make sure you are using Yarn Classic
* https://classic.yarnpkg.com/lang/en/docs/install - https://classic.yarnpkg.com/lang/en/docs/install