andreas/ente-cloudron
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit for Ente Cloudron package

Browse Source
This commit is contained in:
Andreas Düren 2025-03-14 21:01:18 +01:00
commit c2faaf16fb
136 changed files with 7603 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.dockerignore Normal file
View File

@ -0,0 +1,9 @@
.git
.github
.gitignore
.vscode
.idea
README.md
CHANGELOG.md
LICENSE
node_modules

26
.gitignore vendored Normal file
View File

@ -0,0 +1,26 @@
# Build artifacts
dist/
build/
*.tar.gz
# Node.js
node_modules/
npm-debug.log
yarn-debug.log
yarn-error.log
# Environment variables
.env
# OS files
.DS_Store
Thumbs.db
# Editor files
.idea/
.vscode/
*.swp
*.swo
# Cloudron
.cloudron.manifest

9
CHANGELOG.md Normal file
View File

@ -0,0 +1,9 @@
# Changelog
## 1.0.0 (2024-06-01)
* Initial release of Ente for Cloudron
* Integrates with PostgreSQL database
* Integrates with S3-compatible object storage
* Integrates with Cloudron mail system
* Provides web UI for photos and authentication

31
CloudronManifest.json Normal file
View File

@ -0,0 +1,31 @@
{
"id": "io.ente.cloudronapp",
"title": "Ente",
"author": "Ente Authors",
"description": "file://DESCRIPTION.md",
"changelog": "file://CHANGELOG.md",
"contactEmail": "contact@ente.io",
"tagline": "Open Source End-to-End Encrypted Photos & Authentication",
"upstreamVersion": "1.0.0",
"version": "1.0.0",
"healthCheckPath": "/",
"httpPort": 8080,
"memoryLimit": 1073741824,
"addons": {
"localstorage": {},
"postgresql": {},
"sendmail": {
"supportsDisplayName": true
}
},
"icon": "file://logo.png",
"tags": [
"photos",
"authentication",
"e2ee",
"encryption"
],
"manifestVersion": 2,
"minBoxVersion": "8.1.0",
"website": "https://ente.io"
}

18
DESCRIPTION.md Normal file
View File

@ -0,0 +1,18 @@
Ente is an open source, end-to-end encrypted alternative to Google Photos and Apple Photos.
## Features
- End-to-end encryption for all your photos and videos
- Family sharing with fine-grained access control
- Beautiful, modern UI that prioritizes privacy
- Cross-platform support (iOS, Android, Web, and Desktop)
- Ente Auth (optional) - an end-to-end encrypted authentication solution
- Self-hostable with Docker
## Cloudron Integration
This package makes it easy to run your own instance of Ente on your Cloudron server, with PostgreSQL and object storage integration.
## Important Requirements
You will need to provide your own S3-compatible storage service (AWS S3, MinIO, DigitalOcean Spaces, etc.) for storing photos and videos. Detailed configuration instructions are provided after installation.

31
Dockerfile Normal file
View File

@ -0,0 +1,31 @@
FROM cloudron/base:5.0.0@sha256:04fd70dbd8ad6149c19de39e35718e024417c3e01dc9c6637eaf4a41ec4e596c
# Install necessary packages
RUN apt-get update && \
apt-get install -y curl git nodejs npm && \
npm install -g yarn && \
apt-get clean && apt-get autoremove && \
rm -rf /var/cache/apt /var/lib/apt/lists
# Set up directory structure
RUN mkdir -p /app/code /app/data
WORKDIR /app/code
# Clone the ente repository
RUN git clone https://github.com/ente-io/ente.git . && \
cd server && \
mkdir -p /app/data/config
# Copy configuration and startup scripts
ADD start.sh /app/pkg/
ADD config.template.yaml /app/pkg/
# Set proper permissions
RUN chmod +x /app/pkg/start.sh
# Expose the web port
EXPOSE 8080
# Start the application
CMD ["/app/pkg/start.sh"]

25
POSTINSTALL.md Normal file
View File

@ -0,0 +1,25 @@
Your Ente installation is almost ready!
## Required: S3 Storage Configuration
Before you can use Ente, you need to configure an S3-compatible storage service:
1. Go to your Cloudron dashboard
2. Click on your Ente app
3. Click on "Terminal"
4. Edit the S3 configuration template:
```
nano /app/data/config/s3.env.template
```
5. Fill in your S3 credentials (AWS S3, MinIO, DigitalOcean Spaces, etc.)
6. Save the file and rename it:
```
mv /app/data/config/s3.env.template /app/data/config/s3.env
```
7. Restart your Ente app from the Cloudron dashboard
## Next Steps
1. Once S3 is configured, visit your app URL to create an admin account
2. Configure your mobile apps to use your custom self-hosted server (Settings → Advanced → Custom Server)
3. Enjoy your private, end-to-end encrypted photo storage!

86
README.md Normal file
View File

@ -0,0 +1,86 @@
# Ente Cloudron App
This repository contains the Cloudron packaging for [Ente](https://ente.io), an open-source, end-to-end encrypted alternative to Google Photos and Apple Photos.
## Features
- Self-host your own encrypted photo backup service
- Automatically integrates with Cloudron's PostgreSQL database
- Uses Cloudron's object storage for file storage
- Configured to use Cloudron's mail service for sending emails
- Easy to deploy and manage through the Cloudron interface
## Building and Installing
### Option 1: Build and Install Manually
1. Clone this repository:
```
git clone https://github.com/yourusername/ente-cloudron.git
cd ente-cloudron
```
2. Download the Cloudron CLI:
```
npm install -g cloudron
```
3. Build the app:
```
cloudron build
```
4. Install the app:
```
cloudron install --app ente.yourdomain.com
```
### Option 2: Install from the Cloudron App Store
Once this app is accepted into the Cloudron App Store, you can install it directly:
1. Go to your Cloudron dashboard
2. Click "App Store"
3. Search for "Ente"
4. Click "Install"
## Configuration
The app is configured automatically using Cloudron's environment variables for:
- PostgreSQL database connection
- S3-compatible object storage
- SMTP mail service
- App origin URL
## Usage
### Web Client
After installation, you can access the Ente web client at your app's URL. Create an admin account on first use.
### Mobile Apps
You can use the official Ente mobile apps with your self-hosted server:
1. Download the Ente app from the [App Store](https://apps.apple.com/app/id1542026904) or [Google Play](https://play.google.com/store/apps/details?id=io.ente.photos)
2. During login, choose "Custom Server"
3. Enter your Cloudron app URL (e.g., `https://ente.yourdomain.com`)
## Updating
To update to a newer version:
```
cloudron update --app ente.yourdomain.com
```
## Troubleshooting
For issues specific to the Cloudron packaging, please open an issue in this repository.
For issues with Ente itself, please refer to the [main Ente repository](https://github.com/ente-io/ente).
## License
This Cloudron package is licensed under the same license as Ente (Apache 2.0).

44
config.template.yaml Normal file
View File

@ -0,0 +1,44 @@
server:
host: "0.0.0.0"
port: 8080
baseURL: "%%APP_ORIGIN%%"
cors:
origins: ["%%APP_ORIGIN%%"]
sessionSecret: "$(openssl rand -hex 32)"
database:
host: "%%POSTGRESQL_HOST%%"
port: %%POSTGRESQL_PORT%%
user: "%%POSTGRESQL_USERNAME%%"
password: "%%POSTGRESQL_PASSWORD%%"
database: "%%POSTGRESQL_DATABASE%%"
ssl: true
storage:
type: "s3"
s3:
endpoint: "%%S3_ENDPOINT%%"
region: "%%S3_REGION%%"
bucket: "%%S3_BUCKET%%"
accessKey: "%%S3_ACCESS_KEY%%"
secretKey: "%%S3_SECRET_KEY%%"
prefix: "%%S3_PREFIX%%"
forcePathStyle: true
email:
smtp:
host: "%%MAIL_SMTP_SERVER%%"
port: %%MAIL_SMTP_PORT%%
user: "%%MAIL_SMTP_USERNAME%%"
password: "%%MAIL_SMTP_PASSWORD%%"
secure: true
from:
email: "%%MAIL_FROM%%"
name: "%%MAIL_FROM_DISPLAY_NAME%%"
auth:
jwtSecret: "$(openssl rand -hex 32)"
tokenExpiry: 86400
logging:
level: "info"

10
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,10 @@
# Dependencies
node_modules/
# macOS
.DS_Store
# VitePress' dev server cache
docs/.vitepress/cache
# VitePress' production build
docs/.vitepress/dist

4
docs/.prettierrc.json Normal file
View File

@ -0,0 +1,4 @@
{
"tabWidth": 4,
"proseWrap": "always"
}

54
docs/README.md Normal file
View File

@ -0,0 +1,54 @@
# Docs
Help and documentation for Ente's products.
You can find the live version of these at
**[help.ente.io](https://help.ente.io)**.
## Quick edits
You can edit these files directly on GitHub and open a pull request.
[help.ente.io](https://help.ente.io) will automatically get updated with your
changes in a few minutes after your pull request is merged.
## Running locally
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
it easier to run things locally.
Clone this repository
```sh
git clone https://github.com/ente-io/ente
```
Change to this directory
```sh
cd ente/docs
```
Install dependencies
```sh
yarn install
```
Then start a local server
```sh
yarn dev
```
For an editor, VSCode is a good choice. Also install the Prettier extension for
VSCode, and set VSCode to format on save. This way the editor will automatically
format and wrap the text using the project's standard, so you can just focus on
the content. You can also format without VSCode by using the `yarn pretty`
command.
## Have fun!
If you're unsure about how to do something, just look around in the other files
and copy paste whatever seems to match the look of what you're trying to do. And
remember, writing docs should not be a chore, have fun!

42
docs/docs/.vitepress/config.ts Normal file
View File

@ -0,0 +1,42 @@
import { defineConfig } from "vitepress";
import { sidebar } from "./sidebar";
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Ente Help",
description: "Documentation and help for Ente's products",
head: [["link", { rel: "icon", type: "image/png", href: "/favicon.png" }]],
cleanUrls: true,
ignoreDeadLinks: "localhostLinks",
vite: {
build: {
rollupOptions: {
external: ['client-museum-s3.png'] // Added to handle static asset import
}
}
},
themeConfig: {
// We use the default theme (with some CSS color overrides). This
// themeConfig block can be used to further customize the default theme.
//
// https://vitepress.dev/reference/default-theme-config
logo: "/logo.png",
externalLinkIcon: true,
editLink: {
pattern:
"https://github.com/ente-io/ente/edit/main/docs/docs/:path",
},
search: {
provider: "local",
options: {
detailedView: true,
},
},
sidebar: sidebar,
socialLinks: [
{ icon: "github", link: "https://github.com/ente-io/ente/" },
{ icon: "twitter", link: "https://twitter.com/enteio" },
{ icon: "discord", link: "https://discord.gg/z2YVKkycX3" },
],
},
});

334
docs/docs/.vitepress/sidebar.ts Normal file
View File

@ -0,0 +1,334 @@
// When adding new pages, they need to be manually inserted into their
// appropriate place here.
export const sidebar = [
{
text: "Photos",
items: [
{ text: "Introduction", link: "/photos/" },
{
text: "Features",
collapsed: true,
items: [
{ text: "Albums", link: "/photos/features/albums" },
{ text: "Archiving", link: "/photos/features/archive" },
{
text: "Background sync",
link: "/photos/features/background",
},
{ text: "Backup", link: "/photos/features/backup" },
{ text: "Cast", link: "/photos/features/cast/" },
{
text: "Collaboration",
link: "/photos/features/collaborate",
},
{
text: "Collecting photos",
link: "/photos/features/collect",
},
{
text: "Deduplicate",
link: "/photos/features/deduplicate",
},
{
text: "Family plans",
link: "/photos/features/family-plans",
},
{
text: "Free up space",
link: "/photos/features/free-up-space/",
},
{ text: "Hidden photos", link: "/photos/features/hide" },
{
text: "Legacy",
link: "/photos/features/legacy/",
},
{
text: "Location tags",
link: "/photos/features/location-tags",
},
{
text: "Machine learning",
link: "/photos/features/machine-learning",
},
{ text: "Map", link: "/photos/features/map" },
{
text: "Passkeys",
link: "/photos/features/passkeys",
},
{
text: "Public link",
link: "/photos/features/public-link",
},
{ text: "Quick link", link: "/photos/features/quick-link" },
{
text: "Referral program",
link: "/photos/features/referral-program/",
},
{ text: "Sharing", link: "/photos/features/share" },
{ text: "Trash", link: "/photos/features/trash" },
{
text: "Uncategorized",
link: "/photos/features/uncategorized",
},
{
text: "Watch folders",
link: "/photos/features/watch-folders",
},
],
},
{
text: "Migration",
collapsed: true,
items: [
{
text: "Introduction",
link: "/photos/migration/",
},
{
text: "From Google Photos",
link: "/photos/migration/from-google-photos/",
},
{
text: "From Apple Photos",
link: "/photos/migration/from-apple-photos/",
},
{
text: "From Amazon Photos",
link: "/photos/migration/from-amazon-photos",
},
{
text: "From your hard disk",
link: "/photos/migration/from-local-hard-disk",
},
{
text: "Exporting your data",
link: "/photos/migration/export/",
},
],
},
{
text: "FAQ",
collapsed: true,
items: [
{ text: "General", link: "/photos/faq/general" },
{ text: "Installation", link: "/photos/faq/installing" },
{
text: "Export",
link: "/photos/faq/export",
},
{
text: "Metadata",
link: "/photos/faq/metadata",
},
{
text: "Security and privacy",
link: "/photos/faq/security-and-privacy",
},
{
text: "Subscription and plans",
link: "/photos/faq/subscription",
},
{
text: "Hide vs archive",
link: "/photos/faq/hidden-and-archive",
},
{
text: "Face recognition",
link: "/photos/faq/face-recognition",
},
{
text: "Video streaming",
link: "/photos/faq/video-streaming",
},
],
},
{
text: "Troubleshooting",
collapsed: true,
items: [
{
text: "Desktop install",
link: "/photos/troubleshooting/desktop-install/",
},
{
text: "Files not uploading",
link: "/photos/troubleshooting/files-not-uploading",
},
{
text: "Missing thumbnails",
link: "/photos/troubleshooting/thumbnails",
},
{
text: "Large uploads",
link: "/photos/troubleshooting/large-uploads",
},
{
text: "Network drives",
link: "/photos/troubleshooting/nas",
},
{
text: "Sharing debug logs",
link: "/photos/troubleshooting/sharing-logs",
},
],
},
],
},
{
text: "Auth",
items: [
{ text: "Introduction", link: "/auth/" },
{
text: "FAQ",
collapsed: true,
items: [
{ text: "General", link: "/auth/faq/" },
{ text: "Installation", link: "/auth/faq/installing" },
{
text: "Enteception",
link: "/auth/faq/enteception/",
},
{
text: "Privacy disclosure",
link: "/auth/faq/privacy-disclosure/",
},
],
},
{
text: "Migration",
collapsed: true,
items: [
{ text: "Introduction", link: "/auth/migration-guides/" },
{
text: "From Authy",
link: "/auth/migration-guides/authy/",
},
{
text: "From Steam",
link: "/auth/migration-guides/steam/",
},
{
text: "From others",
link: "/auth/migration-guides/import",
},
{
text: "Exporting your data",
link: "/auth/migration-guides/export",
},
],
},
{
text: "Troubleshooting",
items: [
{
text: "Windows login",
link: "/auth/troubleshooting/windows-login",
},
],
},
],
},
{
text: "Self hosting",
collapsed: true,
items: [
{ text: "Getting started", link: "/self-hosting/" },
{
text: "System requirements",
link: "/self-hosting/guides/system-requirements",
},
{
text: "Guides",
items: [
{ text: "Introduction", link: "/self-hosting/guides/" },
{
text: "Connect to custom server",
link: "/self-hosting/guides/custom-server/",
},
{
text: "Hosting the web app",
link: "/self-hosting/guides/web-app",
},
{
text: "Configuring S3",
link: "/self-hosting/guides/configuring-s3",
},
{
text: "Hosting Ente with external S3 (Community)",
link: "/self-hosting/guides/external-s3",
},
{
text: "DB migration",
link: "/self-hosting/guides/db-migration",
},
{
text: "Hosting Ente without Docker",
link: "/self-hosting/guides/standalone-ente",
},
{
text: "Ente via Tailscale (Community)",
link: "/self-hosting/guides/Tailscale.md",
},
{
text: "Configure CLI for Self Hosted Instance",
link: "/self-hosting/guides/selfhost-cli",
},
{
text: "Administering your server",
link: "/self-hosting/guides/admin",
},
{
text: "Mobile build",
link: "/self-hosting/guides/mobile-build",
},
],
},
{
text: "FAQ",
items: [
{ text: "General", link: "/self-hosting/faq/" },
{
text: "Verification code",
link: "/self-hosting/faq/otp",
},
{
text: "Shared albums",
link: "/self-hosting/faq/sharing",
},
{
text: "Backups",
link: "/self-hosting/faq/backup",
},
],
},
{
text: "Troubleshooting",
items: [
{
text: "Uploads",
link: "/self-hosting/troubleshooting/uploads",
},
{
text: "Yarn",
link: "/self-hosting/troubleshooting/yarn",
},
{
text: "Ente CLI Secrets",
link: "/self-hosting/troubleshooting/keyring",
},
],
},
],
},
{
text: "About",
link: "/about/",
},
{
text: "Contribute",
link: "/about/contribute",
},
];

19
docs/docs/.vitepress/theme/custom.css Normal file
View File

@ -0,0 +1,19 @@
:root {
--ente-theme-color: #1db954;
--ente-theme-color-alt: #00b33c;
--vp-theme-color: var(--ente-theme-color);
--vp-c-brand: var(--ente-theme-color);
--vp-c-brand-1: var(--ente-theme-color);
--vp-c-brand-2: var(--ente-theme-color-alt);
--vp-home-hero-name-color: var(--ente-theme-color);
--vp-c-brand-light: var(--ente-theme-color);
--vp-button-brand-border: var(--ente-theme-color);
--vp-button-brand-bg: var(--ente-theme-color);
--vp-button-brand-text: #191919;
--vp-button-brand-hover-border: var(--ente-theme-color-alt);
--vp-button-brand-hover-bg: #191919;
--vp-button-brand-hover-text: #e5e5e5;
--vp-local-search-highlight-bg: var(--ente-theme-color);
--docsearch-hit-active-color: #191919;
}

4
docs/docs/.vitepress/theme/index.js Normal file
View File

@ -0,0 +1,4 @@
import DefaultTheme from "vitepress/theme";
import "./custom.css";
export default DefaultTheme;

15
docs/docs/about/contribute.md Normal file
View File

@ -0,0 +1,15 @@
---
title: Contribute
description: Details about how to contribute to Ente's docs
---
# Contributing
To contribute to these docs, you can use the "Edit this page" button at the
bottom of each page. This will allow you to directly edit the markdown file that
is used to generate this documentation and open a quick pull request directly
from GitHub's UI.
If you're more comfortable in contributing with your text editor, see the
`docs/` folder of our GitHub repository,
[github.com/ente-io/ente](https://github.com/ente-io/ente).

BIN
docs/docs/about/ducky.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 87 KiB

72
docs/docs/about/index.md Normal file
View File

@ -0,0 +1,72 @@
---
title: About Ente
description: >
An overview of Ente: the company, and the people behind it, and the products
that we make.
---
# About
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
products:
- **Ente Photos** - An alternative to Google Photos and Apple Photos
- **Ente Auth** - A free 2FA alternative to Authy
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
browser without you needing to install anything.
More products are in the pipeline.
## History
Ente was the founded by Vishnu Mohandas (he's also Ente's CEO) in response to
privacy concerns with major tech companies. The underlying motivation was the
understanding that big tech had no incentive to fix their act, but with
end-to-end encrypted cross platform apps, there was a way for people to take
back control over their own data without sacrificing on features.
### What does Ente mean?
In Malayalam, Vishnu's native language, "ente" means "mine". Thus "Ente Photos"
has the literal meaning "my photos".
This was a good name, but still Vishnu looked around for better ones. But one
day, he discovered that "ente" means "duck" in German. This unexpected
connection sealed the deal. We should ask him why he likes ducks so much, but
apparently he does, so this dual meaning ("mine" / "duck") led him to finalize
the name, and also led to the adoption of "Ducky", Ente's mascot:
<div align="center">
![Ente's mascot, Ducky](ducky.png){width=200px}
</div>
For the full origin story of Ducky you can check out
[this blog post](https://ente.io/blog/ducky/).
### How do I pronounce Ente?
en-_tay_. Like ca<i>fe</i>.
## Get in touch
If you have a support query that is not answered by these docs, please reach out
to our Customer Support by sending an email to support@ente.io
To stay up to date with new product launches, and behind the scenes details of
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))
To suggest new features and/or offer your perspective on how we should design
planned and upcoming features, use our
[GitHub discussions](https://github.com/ente-io/ente/discussions)
Or if you'd just like to hang out, join our
[Discord](https://discord.gg/z2YVKkycX3), follow us on
[Twitter](https://twitter.com/enteio) or give us a shout out on
[Mastodon](https://mstdn.social/@ente)

51
docs/docs/auth/faq/enteception/index.md Normal file
View File

@ -0,0 +1,51 @@
---
title: Enteception
description: Using Ente Auth to store 2FA for your Ente account
---
# Enteception
Your 2FA codes are in Ente Auth, but if you enable 2FA for your Ente account
itself, where should the 2FA for your Ente account be stored?
There are multiple answers, none of which are better or worse, they just depend
on your situation and risk tolerance.
If you are using the same account for both Ente Photos and Ente Auth and have
enabled 2FA from the Ente Photos app, we recommend that you ensure you store
your recovery key in a safe place (writing it down on a paper is a good idea).
This key can be used to bypass Ente 2FA in case you are locked out.
Another option is to use a separate account for Ente Auth.
Also, taking exporting the encrypted backup is also another good way to reduce
the risk (you can easily import the encrypted backup without signing in).
Finally, we have on our roadmap some features like adding support for
emergency/legacy-contacts, passkeys, and hardware security keys. Beyond other
benefits, all of these would further reduce the risk of users getting locked out
of their accounts.
## Email verification for Ente Auth
There is a related ouroboros scenario where if email verification is enabled in
the Ente Auth app _and_ the 2FA for your email provider is stored in Ente Auth,
then you might need a code from your email to log into Ente Auth, but to log
into your email you needed the Auth code.
To prevent people from accidentally locking themselves out this way, email
verification is disabled by default in the auth app. We also try to show a
warning when you try to enable email verification in the auth app:
<div align="center">
![Warning shown when enabling 2FA in Ente Auth](warning.png){width=400px}
</div>
The solution here are the same as the Ente-in-Ente case.
## TL;DR;
Ideally, you should **note down your recovery key in a safe place (may be on a
paper)**, using which you will be able to by-pass the two factor.

BIN
docs/docs/auth/faq/enteception/warning.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 516 KiB

72
docs/docs/auth/faq/index.md Normal file
View File

@ -0,0 +1,72 @@
---
title: FAQ - Auth
description: Frequently asked questions about Ente Auth
---
# Frequently Asked Questions
### How secure is Ente Auth?
All codes you backup via Ente is stored with end-to-end encryption. This means
only you can access your codes. Our apps are open source and our cryptography
has been externally audited.
### How can I delete or edit codes?
You can delete or edit a code by long pressing (or right clicking on desktop) on
that item.
### How can I support this project?
You can support the development of this project by subscribing to our Photos app
at [ente.io](https://ente.io).
### How can I enable FaceID lock in Ente Auth?
You can enable FaceID lock under Settings → Security → Lockscreen.
### How secure is the lock screen provided by Ente Auth?
Auth's lock screen acts as a barrier to prevent an attacker from accessing the
contents of the app. It does not introduce a layer of cryptographic security.
### Why do the desktop and mobile apps display different codes?
Please verify that the time on both your mobile and desktop is the same.
The codes depend on time. If the time is the same on both your browser and
mobile, the codes you see will be the same.
Usually, this discrepancy occurs because the time in your browser might be
incorrect. In particular, multiple users have reported that Firefox provides
incorrect time when certain privacy settings are enabled.
### Can I access my codes on web?
You can access your codes on the web at [auth.ente.io](https://auth.ente.io).
### Does Ente Auth require an account?
No, Ente Auth does not require an account. You can choose to use the app without
backups if you prefer.
### Can I use Ente Auth on multiple devices and sync them?
Yes, you can download Ente Auth on multiple devices and sync the codes with
end-to-end encryption.
### What information about my codes is stored on Ente server?
Due to E2EE, the server doesn't know anything about your codes. Everything is
encrypted, including the tags, type, account, issuer, notes, pinned or trash
status, etc.
### What does it mean when I receive a message saying that my current device isn't powerful enough to verify my password?
This means that the parameters that were used to derive your master-key on your
original device, are incompatible with your current device (likely because it's
less powerful).
If you recover your account using your current device and reset the password, a
new key will be generated with different parameters. This new key will be
equally strong and compatible with both devices.

94
docs/docs/auth/faq/installing.md Normal file
View File

@ -0,0 +1,94 @@
---
title: Installing Ente Auth
description: Steps to install Ente Auth
---
# Android
Our Android apps are distributed over the following channels.
### PlayStore
You can install Auth directly from
[PlayStore](https://play.google.com/store/apps/details?id=io.ente.auth).
### F-Droid
Reproducible builds for Auth are available on
[F-Droid](https://f-droid.org/packages/io.ente.auth/).
> [!NOTE]
>
> Releases over F-Droid are generally slower since they run their own build
> servers. You can donate to F-Droid [here](https://f-droid.org/en/donate).
### GitHub
Latest releases are built straight from the source and made available over
[GitHub](https://github.com/ente-io/ente/releases?q=tag%3Aauth-v4).
These builds will notify you whenever a new release is available and will help
you stay updated.
### Obtainium
You can setup [Obtainium](https://github.com/ImranR98/Obtainium) to track our
GitHub releases by
[clicking this link](https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/%7B%22id%22%3A%22io.ente.auth.independent%22%2C%22url%22%3A%22https%3A%2F%2Fgithub.com%2Fente-io%2Fente%22%2C%22author%22%3A%22ente-io%22%2C%22name%22%3A%22Ente%20Auth%22%2C%22preferredApkIndex%22%3A0%2C%22additionalSettings%22%3A%22%7B%5C%22includePrereleases%5C%22%3Afalse%2C%5C%22fallbackToOlderReleases%5C%22%3Atrue%2C%5C%22filterReleaseTitlesByRegEx%5C%22%3A%5C%22%5C%22%2C%5C%22filterReleaseNotesByRegEx%5C%22%3A%5C%22%5C%22%2C%5C%22verifyLatestTag%5C%22%3Afalse%2C%5C%22dontSortReleasesList%5C%22%3Atrue%2C%5C%22useLatestAssetDateAsReleaseDate%5C%22%3Afalse%2C%5C%22releaseTitleAsVersion%5C%22%3Afalse%2C%5C%22trackOnly%5C%22%3Afalse%2C%5C%22versionExtractionRegEx%5C%22%3A%5C%22%5C%22%2C%5C%22matchGroupToUse%5C%22%3A%5C%22%5C%22%2C%5C%22versionDetection%5C%22%3Atrue%2C%5C%22releaseDateAsVersion%5C%22%3Afalse%2C%5C%22useVersionCodeAsOSVersion%5C%22%3Afalse%2C%5C%22apkFilterRegEx%5C%22%3A%5C%22ente-auth*%5C%22%2C%5C%22invertAPKFilter%5C%22%3Afalse%2C%5C%22autoApkFilterByArch%5C%22%3Atrue%2C%5C%22appName%5C%22%3A%5C%22%5C%22%2C%5C%22shizukuPretendToBeGooglePlay%5C%22%3Afalse%2C%5C%22allowInsecure%5C%22%3Afalse%2C%5C%22exemptFromBackgroundUpdates%5C%22%3Afalse%2C%5C%22skipUpdateNotifications%5C%22%3Afalse%2C%5C%22about%5C%22%3A%5C%22%5C%22%7D%22%2C%22overrideSource%22%3Anull%7D)
to add it instantly.
Alternatively, you can follow these steps:
1. Click **Add App** to open a new app config screen
2. Enter `https://github.com/ente-io/ente` in the **App Source URL** field
3. Enable the **Retain release order** from API toggle
4. Scroll down to the **Filter APKs by Regular Expression** field and enter
`ente-auth*`
5. Enable the **Attempt to filter APKs by CPU architecture** if possible toggle
6. Select any applicable app category labels you may have setup
7. Enable the **Try inferring app ID from source code** toggle
8. Scroll back to the top and click **Add** to complete the setup
<br/>
---
<br/>
# iOS
You can install Ente Auth on Apple devices from
[AppStore](https://apps.apple.com/us/app/ente-auth/id6444121398).
<br/>
---
<br/>
# Desktop
You can grab the latest version of Ente Auth for Mac, Windows and Linux from
[GitHub](https://github.com/ente-io/ente/releases?q=tag%3Aauth-v4).
<br/>
---
<br/>
# Web
Latest versions of our web app are available at
[auth.ente.io](https://auth.ente.io).
<br/>
---
<br/>
# CLI
Ente's CLI is distributed directly over
[GitHub](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0).

BIN
docs/docs/auth/faq/privacy-disclosure/appstore-privacy-disclosure.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 145 KiB

56
docs/docs/auth/faq/privacy-disclosure/index.md Normal file
View File

@ -0,0 +1,56 @@
---
title: Apple's app privacy disclosure
description: Breakdown of the app privacy disclosure submitted to AppStore
---
# Apple's app privacy disclosure
Here is a breakdown of the types of data that are being collected as per
AppStore's privacy disclosure.
<div align="center">
![Privacy disclosure submitted to
AppStore](appstore-privacy-disclosure.png){width=620px}
</div>
## Data Linked to You
> [!NOTE]
>
> Only if you choose to create an account to backup your codes are the following
> details collected.
### Contact Info
This is your email address, used for account creation and communication.
### User Content
This are your 2FA secrets, end-to-end encrypted with a key that only you have
access to.
### Identifiers
This is your user ID generated by our server during sign up.
## Data Not Linked to You
> [!NOTE]
>
> Only if you opt-in to **Crash reporting** are the following details collected.
### Diagnostics
These are anonymized error reports and other diagnostics data that make it
easier for us to detect and fix any issues.
---
## Summary
Ente Auth collects no data by default.
For more details, please refer to our
[full privacy policy](https://ente.io/privacy).

9
docs/docs/auth/index.md Normal file
View File

@ -0,0 +1,9 @@
---
title: Ente Auth
description: User guide for Ente Auth
---
# Ente Auth
Ente Auth is a free, cross-platform, end-to-end encrypted authenticator app. You
can use it to safely store your 2FA codes (second-factor authentication codes).

237
docs/docs/auth/migration-guides/authy/index.md Normal file
View File

@ -0,0 +1,237 @@
---
title: Migrating from Authy
description: Guide for importing your existing Authy 2FA tokens into Ente Auth
---
# Migrating from Authy
A guide written by Green, an ente.io lover
> [!WARNING]
>
> Authy has dropped all support for its desktop apps. It is no longer possible
> to export data from Authy using methods 1 and 2. You will either need a rooted
> android phone or you will need to reconfigure 2FA for each of your accounts.
---
Migrating from Authy can be tiring, as you cannot export your 2FA codes through
the app, meaning that you would have to reconfigure 2FA for all of your accounts
for your new 2FA authenticator. However, easier ways exist to export your codes
out of Authy. This guide will cover two of the most used methods for migrating
from Authy to Ente Authenticator.
> [!CAUTION]
>
> Under any circumstances, do **NOT** share any JSON and TXT files generated
> using this guide, as they contain your **unencrypted** TOTP secrets!
>
> Also, there is **NO GUARANTEE** that these methods will export ALL of your
> codes. Make sure that all your accounts have been imported successfully before
> deleting any codes from your Authy account!
---
## Method 1: Use Neeraj's export tool
**Who should use this?** General users who want to save time by skipping the
hard (and rather technical) parts of the process.<br><br>
One way to export is to
[use this tool by Neeraj](https://github.com/ua741/authy-export/releases/tag/v0.0.4)
to simplify the process and skip directly to importing to Ente Authenticator.
To export from Authy, download the tool for your specific OS, then type the
following in your terminal:
```
./<binary-name> <path_to_export_file>
```
Assuming the filename of the binary remains unmodified and the working directory
of the terminal is the location of the binary, you should type this for MacOS:
> [!NOTE]
>
> On Apple Silicon devices, Rosetta 2 may be required to run the binary.
```
./authy-export-darwin-amd64 authy_codes.txt
```
For Linux:
```
./authy-export-linux-amd64 authy_codes.txt
```
For Windows:
```
./authy-export-windows-amd64.exe authy_codes.txt
```
This will generate a text file called `authy_codes.txt`, which contains your
Authy codes in Ente's plaintext export format. You can now import this to Ente
Authenticator!
## Method 2: Use gboudreau's GitHub guide
**Who should use this?** Power users who have spare time on their hands and
prefer a more "known and established" solution to exporting Authy codes.<br><br>
A user on GitHub (gboudreau) wrote a guide to export codes from Authy (morpheus
on Discord found this and showed it to us), so we are going to be using that for
the migration.
To export your data, please follow
[this guide](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93).
This will create a JSON file called `authy-to-bitwarden-export.json`, which
contains your Authy codes in Bitwarden's export format. You can now import this
to Ente Authenticator!
### Method 2.1: If the export worked, but the import didn't
> [!NOTE]
>
> This is intended only for users who successfully exported their codes using
> the guide in method 2, but could not import it to Ente Authenticator for
> whatever reason. If the import was successful, or you haven't tried to import
> the codes yet, ignore this section.
>
> If the export itself failed, try using
> [**method 1**](#method-1-use-neeraj-s-export-tool) instead.
Usually, you should be able to import Bitwarden exports directly into Ente
Authenticator. In case this didn't work for whatever reason, I've written a
program in Python that converts the JSON file into a TXT file that Ente
Authenticator can use, so you can try importing using plain text import instead.
You can download my program
[here](https://github.com/gweeeen/ducky/blob/main/duckys_other_stuff/authy_to_ente.py),
or you can copy the program below:
```py
import json
import os
totp = []
accounts = json.load(open('authy-to-bitwarden-export.json','r',encoding='utf-8'))
for account in accounts['items']:
totp.append(account['login']['totp']+'\n')
writer = open('auth_codes.txt','w+',encoding='utf-8')
writer.writelines(totp)
writer.close()
print('Saved to ' + os.getcwd() + '/auth_codes.txt')
```
To convert the file with this program, you will need to install
[Python](https://www.python.org/downloads/) on your computer.
Before you run the program, make sure that both the Python program and the JSON
file are in the same directory, otherwise this will not work!
To run the Python program, open it in your IDE and run the program, or open your
terminal and type `python3 authy_to_ente.py` (MacOS/Linux, or any other OS that
uses bash) or `py -3 authy_to_ente.py` (Windows). Once you run it, a new TXT
file called `auth_codes.txt` will be generated. You can now import your data to
Ente Authenticator!
---
You should now have a TXT file (method 1, method 2.1) or a JSON file (method 2)
that countains your TOTP secrets, which can now be imported into Ente
Authenticator. To import your codes, please follow one of the steps below,
depending on which method you used to export your codes.
## Method 3
**Who should use this?** Power users who have spare time on their hands and who
have a rooted android phone running android 6 or newer that passes Play
Integrity.
This way of exporting your data will require a rooted phone.
### Exporting codes using Android OTP Extractor
This uses the tool
[Android OTP Extractor](https://github.com/puddly/android-otp-extractor) from
[puddly](https://github.com/puddly) on GitHub
1. Install python 3 and adb to your computer you can download binaries for it
from [Google](https://developer.android.com/tools/releases/platform-tools)
2. Add adb to your path. 2.1. On windows search for "Edit the system environment
variables" 2.2. Click "Environment Variables" 2.3. At the top in "User
variables" click the "path" variable and then click "Edit" 2.4. Click "New"
and type the path to where you extracted the Platform Tools
3. Enable USB debugging on the Android Phone 3.1. Open settings 3.2. Open "About
phone" (Might say tablet depending on what device you use) (skip steps 3.2
and 3.3 if you already have developer options enabled) 3.3. Tap "Build
Number" 7 or more times 3.4. Go to the main settings page 3.5. Open "System
Settings" 3.6. Open "Developer options" 3.7. Enable "USB Debugging" 3.8. On
your computer verify the phone is connected by running `adb devices` (You may
need to tap "Allow" on the device to allow the computer to access it)
4. Install Android OTP Extractor using pip
```
pip install git+https://github.com/puddly/android-otp-extractor
```
5. Install Authy from the playstore and login to your account
6. Run the command below to export the TOTP to QRCodes and URLS
```
python -m android_otp_extractor --prepend-issuer --include authy
```
### Exporting codes using Aegis Authenticator
This uses the tool [Aegis Authenticator](https://getaegis.app/) from
[beemdevelopment](https://github.com/beemdevelopment).
1. Install Authy and login on your rooted phone.
2. Install Aegis Authenticator from the
[Google Play Store](https://play.google.com/store/apps/details?id=com.beemdevelopment.aegis).
3. In the app, click the three dots in the top right corner and click "Import &
Export".
4. Click "Import from another app" and choose Authy.
5. The app will ask for root permissions, then automatically import your codes
from Authy.
6. Then export the codes from Aegis Authenticator to `json` or `txt` using the
"Export to file" option in the "Import & Export" menu.
## Importing to Ente Authenticator (Method 1, method 2.1)
1. Copy the TXT file to one of your devices with Ente Authenticator.
2. Log in to your account (if you haven't already), or press "Use without
backups".
3. Open the navigation menu (hamburger button on the top left), then press
"Data", then press "Import codes".
4. Select the "Plain text" option.
5. Select the TXT file that was made earlier.
## Importing to Ente Authenticator (Method 2)
1. Copy the JSON file to one of your devices with Ente Authenticator.
2. Log in to your account (if you haven't already), or press "Use without
backups".
3. Open the navigation menu (hamburger button on the top left), then press
"Data", then press "Import codes".
4. Select the "Bitwarden" option.
5. Select the JSON file that was made earlier.
If this didn't work, refer to
[**method 2.1**](#method-2-1-if-the-export-worked-but-the-import-didn-t).<br><br>
## Importing to Ente Authenticator (Method 3)
1. Open Ente Authenticator on your phone
2. Log in to your account (if you haven't already), or press "Use without
backups".
3. Click the add button in the bottom right of the app.
4. Select "Scan a QR code" and scan the code from the browser.
Now that your secrets are safely stored, I recommend you delete the unencrypted
JSON and TXT files that were made during the migration process for security.

91
docs/docs/auth/migration-guides/export.md Normal file
View File

@ -0,0 +1,91 @@
---
title: Exporting your data from Ente Auth
description: Guide for exporting your 2FA codes out from Ente Auth
---
# Exporting your data out of Ente Auth
## Auth Encrypted Export format
### Overview
When we export the auth codes, the data is encrypted using a key derived from
the user's password. This document describes the JSON structure used to organize
exported data, including versioning and key derivation parameters.
### Export JSON Sample
```json
{
"version": 1,
"kdfParams": {
"memLimit": 4096,
"opsLimit": 3,
"salt": "example_salt"
},
"encryptedData": "encrypted_data_here",
"encryptionNonce": "nonce_here"
}
```
The main object used to represent the export data. It contains the following
key-value pairs:
- `version`: The version of the export format.
- `kdfParams`: Key derivation function parameters.
- `encryptedData"`: The encrypted authentication data.
- `encryptionNonce`: The nonce used for encryption.
#### Version
Export version is used to identify the format of the export data.
##### Ver: 1
- KDF Algorithm: `ARGON2ID`
- Decrypted data format: `otpauth://totp/...`, separated by a new line.
- Encryption Algo: `XChaCha20-Poly1305`
##### Key Derivation Function Params (KDF)
This section contains the parameters that were using during KDF operation:
- `memLimit`: Memory limit for the algorithm.
- `opsLimit`: Operations limit for the algorithm.
- `salt`: The salt used in the derivation process.
##### Encrypted Data
As mentioned above, the auth data is encrypted using a key that's derived by
using user provided password & kdf params. For encryption, we are using
`XChaCha20-Poly1305` algorithm.
## Automated backups
You can use [Ente's CLI](https://github.com/ente-io/ente/tree/main/cli#readme)
to automatically backup your Auth codes.
To export your data, add an account using `ente account add` command. In the
first step, specify `auth` as the app name. At a later point, CLI will also ask
you specify the path where it should write the exported codes.
You can change the export directory using following command
```
ente account update --app auth --email <email> --dir <path>
```
## How to use the exported data
- **Ente Authenticator app**: You can directly import the codes in the Ente
Authenticator app.
> Settings -> Data -> Import Codes -> Ente Encrypted export.
- **Decrypt using Ente CLI** : Download the latest version of
[Ente CLI](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0), and run
the following command
```
./ente auth decrypt <export_file> <output_file>
```

39
docs/docs/auth/migration-guides/import.md Normal file
View File

@ -0,0 +1,39 @@
---
title: Migrating from other providers
description:
Guide for importing your existing 2FA tokens into Ente Auth from other
providers
---
# Migrating from other providers
---
Ente Auth natively supports imports from many 2FA providers. In addition to the
providers specifically listed in the documentation, the supported providers are:
- 2FAS Authenticator
- Aegis Authenticator
- Bitwarden
- Google Authenticator
- Raivo OTP
- LastPass
Details as to how codes may be imported from these providers may be found within
the app.
> [!NOTE]
>
> Please note that this list may be out of sync, please see the app for the
> latest set of supported providers.
Ente Auth also supports imports from Auth's own encrypted exports and plain text
files. Plain text files must be in the following format:
`otpauth://totp/provider.com:you@email.com?secret=YOUR_SECRET`
The codes can be separated by a comma or a new line.
So if your provider is not specifically listed, you might be still able to
import from them by first converting the data from your old provider into these
plaintext files and then importing those into Ente.

12
docs/docs/auth/migration-guides/index.md Normal file
View File

@ -0,0 +1,12 @@
---
title: Migrating to Ente Auth
description:
Guides for migrating your existing 2FA tokens into or out of Ente Auth
---
# Migrating to/from Ente Auth
- [Migrating from Authy](authy/)
- [Importing codes from Steam](steam/)
- [Migrating from other apps](import)
- [Exporting your data out of Ente Auth](export)

77
docs/docs/auth/migration-guides/steam/index.md Normal file
View File

@ -0,0 +1,77 @@
---
title: Migrating from Steam Authenticator
description: Guide for importing from Steam Authenticator to Ente Auth
---
# Migrating from Steam Authenticator
> [!WARNING]
>
> Steam Authenticator code is only supported after auth-v3.0.3, check the app's
> version number before migration.
One way to migrate is to [use this tool by dyc3][releases] to simplify the
process and skip directly to generating a qr code to Ente Authenticator.
## Download/Install steamguard-cli
### Windows
1. Download `steamguard.exe` from the [releases page][releases].
2. Place `steamguard.exe` in a folder of your choice. For this example, we will
use `%USERPROFILE%\Desktop`.
3. Open Powershell or Command Prompt. The prompt should be at `%USERPROFILE%`
(eg. `C:\Users\<username>`).
4. Use `cd` to change directory into the folder where you placed
`steamguard.exe`. For this example, it would be `cd Desktop`.
5. You should now be able to run `steamguard.exe` by typing
`.\steamguard.exe --help` and pressing enter.
### Linux
#### Ubuntu/Debian
1. Download the `.deb` from the [releases page][releases].
2. Open a terminal and run this to install it:
```bash
sudo dpkg -i ./steamguard-cli_<version>_amd64.deb
```
#### Other Linux
1. Download `steamguard` from the [releases page][releases]
2. Make it executable, and move `steamguard` to `/usr/local/bin` or any other
directory in your `$PATH`.
```bash
chmod +x ./steamguard
sudo mv ./steamguard /usr/local/bin
```
3. You should now be able to run `steamguard` by typing `steamguard --help` and
pressing enter.
## Login to Steam account
Set up a new account with steamguard-cli
```bash
steamguard setup # set up a new account with steamguard-cli
```
## Generate & importing QR codes
steamguard-cli can then generate a QR code for your 2FA secret.
```bash
steamguard qr # print QR code for the first account in your maFiles
steamguard -u <account name> qr # print QR code for a specific account
```
Open Ente Auth, press the '+' button, select `Scan a QR code`, and scan the qr
code.
You should now have your steam code inside Ente Auth
[releases]: https://github.com/dyc3/steamguard-cli/releases/latest

52
docs/docs/auth/troubleshooting/windows-login.md Normal file
View File

@ -0,0 +1,52 @@
---
title: Unable to login on Windows Desktop
description:
Troubleshooting when you are not able to login or register on Ente Auth app
on Windows
---
# Windows Login Error
### HandshakeException: Handshake error in client
This error usually happens when the Trusted Root certificates on your Windows
machine are outdated.
To update the Trusted Root Certificates on Windows, you can use the `certutil`
command. Here are the steps to do so:
1. **Open Command Prompt as Administrator**:
- Press `Windows + X` and select `Command Prompt (Admin)` or
`Windows PowerShell (Admin)`.
2. **Run the following command to update the root certificates**:
```bash
certutil -generateSSTFromWU roots.sst
```
This command will generate a file named `roots.sst` that contains the latest
root certificates from Windows Update.
3. **Install the new root certificates**:
```bash
certutil -addstore -f ROOT roots.sst
```
This command will add the certificates from the `roots.sst` file to the
Trusted Root Certification Authorities store.
4. **Clean up**: After the installation, you can delete the `roots.sst` file if
you no longer need it:
```bash
del roots.sst
```
Make sure to restart your application after updating the certificates to ensure
the changes take effect.
If the above steps don't resolve the issue, please follow
[this guide](https://woshub.com/updating-trusted-root-certificates-in-windows-10/#h2_3)
to update your trusted root certicates, and try again.

13
docs/docs/de/auth/index.md Normal file
View File

@ -0,0 +1,13 @@
---
title: Ente Auth
description: Ente Auth-Benutzerhandbuch
---
# Ente Auth
Ente Authenticator ist eine kostenlose, plattformübergreifende,
Ende-zu-Ende-verschlüsselte Authenticator-App für jedermann. Wir sind froh, dass
du hier bist!
**Please note that this German translation is currently just a placeholder.**
Know German? [Help us fill this in!](/about/contribute).

15
docs/docs/index.md Normal file
View File

@ -0,0 +1,15 @@
---
title: Home
---
# Welcome!
This site contains documentation and help for Ente Photos and Ente Auth. It
describes various features, and also offers various troubleshooting suggestions.
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
jump directly to page that might contain the information you need.
To know more about Ente, see [about](/about/) or visit our website
[ente.io](https://ente.io).

48
docs/docs/photos/faq/export.md Normal file
View File

@ -0,0 +1,48 @@
---
title: Export FAQ
description: Frequently asked questions about keeping extra backups of your data
---
# Export
## How can I backup my data in a local drive outside Ente?
Yes! You can use our CLI tool or our desktop app to set up exports of your data
to your local drive. This way, you can use Ente in your day to day use, but will
have an additional guarantee that a copy of your original photos and videos are
always available in normal directories and files.
- You can use [Ente's CLI](https://github.com/ente-io/ente/tree/main/cli#export)
to export your data in a cron job to a location of your choice. The exports
are incremental, and will also gracefully handle interruptions.
- Similarly, you can use Ente's [desktop app](https://ente.io/download/desktop)
to export your data to a folder of your choice. The desktop app also supports
"continuous" exports, where it will automatically export new items in the
background without you needing to run any other cron jobs. See
[migration/export](/photos/migration/export/) for more details.
## Does the exported data preserve folder structure?
Yes. When you export your data for local backup, it will maintain the exact
album structure how you have set up within Ente.
## Does the exported data preserve metadata?
Yes, the metadata is written out to a separate JSON file during export. Note
that the original is not modified. For more details, see the
[description of the exported metadata](/photos/faq/metadata#export).
## Can I do a 2-way sync?
A two way sync is not currently supported. Attempting to export data to the same
folder that is also being watched by the Ente app will result in undefined
behaviour (e.g. duplicate files, export stalling etc).
## Why is my export size larger than my backed-up size in Ente?
One possible reason could be that you have files that are in multiple different
albums. Whenever a file is backed-up to Ente in multiple albums it will still
count only once towards the total storage in Ente. However, during export that
file will be downloaded multiple times to the different folders corresponding to
said albums, causing the total export size to be larger.

88
docs/docs/photos/faq/face-recognition.md Normal file
View File

@ -0,0 +1,88 @@
---
title: Face recognition
description:
Frequently asked questions about Ente's face recognition
---
# Face recognition
## Can I merge or de-merge persons recognized by the app?
Yes! The general mechanism for doing this is to assign the same name to both
persons.
### Mobile
First, make sure one of the two person groupings is assigned a name through the
`Add a name` banner. Then for the second grouping, use the same banner but now
instead of typing the name again, tap on the already given name that should now
be listed.
De-merging a certain grouping can be done by going to the person, pressing
`Review suggestions` and then the top right `History icon`. Now press on the
`minus icon` beside the group you want to de-merge.
### Desktop
Similarly, on desktop you can use the "Add a name" button to merge people by
selecting an existing person, and use the "Review suggestions" sheet to de-merge
previously merged persons (click the top right history icon on the suggestion
sheet to see the previous merges, and if necessary, undo them).
## How can I remove an incorrectly grouped face from a person?
On our mobile app, open up the person from the People section, click on the
three dots to open up overflow menu, and click on Edit. Now you will be
presented with the list of all photos that were merged to create this person.
You can click on the merged photos and select the photos you think are
incorrectly grouped (by long-pressing on them) and select "Remove" from the
action bar that pops up to remove any incorrect faces.
## How do I change the cover for a recognized person?
### Mobile
Inside the person group, long-press the image you want to use as cover. Then
press `Use as cover`.
### Desktop
Desktop currently does not support picking a cover. It will default to the most
recent image.
## Can I tell the app to ignore certain recognized person?
Yes! You can tell the app not to show certain persons.
### Mobile
First, make sure the person is not named. If you already gave a name, then first
press `Remove person label` in the top right menu. Now inside the unnamed
grouping, press `Ignore person` from the top right menu.
To undo this action, go to a **photo containing the person**. Go to the **file
info** section of the photo and press on the **face thumbnail of the ignored
person**. This will take you to the grouping of this person. Here you can press
`Show person` to undo ignoring the person.
### Desktop
Similarly, on desktop, you use the "Ignore" option from the top right menu to
ignore a particular face group (If you already give them a name, "Reset person"
first). And to undo this action, open that person (via the file info of a photo
containing that person), and select "Show person".
## How well does the app handle photos of babies?
The face recognition model we use (or any face recognition model for that
matter) is known to struggle with pictures of babies and toddlers. While we
can't prevent all cases where this goes wrong, we've added a option to help you
correct the model in such cases.
If you find a mixed grouping of several different babies, you can use the
`mixed grouping` option in the top right menu of said grouping. Activating this
option will make the model re-evaluate the grouping with stricter settings,
hopefully separating the different babies in different new groupings.
Please note this functionality is currently only available on mobile.

130
docs/docs/photos/faq/general.md Normal file
View File

@ -0,0 +1,130 @@
---
title: General FAQ
description: An assortment of frequently asked questions about Ente Photos
---
# General FAQ
## How can I earn free storage?
Use our [referral program](/photos/features/referral-program/).
## What file formats does Ente support?
Ente supports all files that have a mime type of `image/*` or `video/*`
regardless of their specific format.
However, we only have limited support for RAW currently. We are working towards
adding full support, and you can watch this
[thread](https://github.com/ente-io/ente/discussions/625) for updates.
If you find an issue with ente's ability to parse a certain file type, please
write to [support@ente.io](mailto:support@ente.io) with details of the
unsupported file format and we will do our best to help you out.
## Is there a file size limit?
Yes, we currently do not support files larger than 4 GB.
If this constraint is a concern for you, please write to
[support@ente.io](mailto:support@ente.io) with your use case and we will do our
best to help you.
## Does Ente support videos?
Ente supports backing up and downloading of videos in their original format and
quality.
But some of these formats cannot be streamed on the web browser and you will be
prompted to download them.
## Why does Ente consume lesser storage than other providers?
Most storage providers compute your storage quota in GigaBytes (GBs) by dividing
your total bytes uploaded by `1000 x 1000 x 1000`.
Ente on the other hand, computes your storage quota in GibiBytes (GiBs) by
dividing your total bytes uploaded by `1024 x 1024 x 1024`.
We decided to leave out the **i** from **GiBs** to reduce noise on our
interfaces.
## Why should I trust Ente for long-term data-storage?
Unlike large companies, we have a focused mission, to build a safe space where
you can easily archive your personal memories.
This is the only thing we want to do, and with our pricing model, we can
profitably do it.
We preserve your data end-to-end encrypted, and our open source apps have been
[externally audited](https://ente.io/blog/cryptography-audit/).
Also, we have spent great deal of engineering effort into designing reliable
data replication and graceful disaster recovery plans. This is also done
transparently - we have documented the specifics of our replication and
reliability [here](https://ente.io/reliability).
In short, we love what we do, we have no reasons to be distracted, and we are as
reliable as any one can be.
If you would like to fund the development of this project, please consider
[subscribing](https://ente.io/download).
## How do I pronounce ente?
It's like cafe 😊. kaf-_ay_. en-_tay_.
## Does Ente apply compression to uploaded photos?
Ente does not apply compression to uploaded photos. The file size of your photos
in Ente will be similar to the original file sizes you have.
## Can I add photos from a shared album to albums that I created in Ente?
On Ente's mobile apps, you can add photos from an album that's shared with you,
into one of your own albums. This will create a copy of the item that you fully
own, and will count against your storage quota.
## How do I ensure that the Ente desktop app stays up to date on my system?
Ente desktop includes an auto-update feature, ensuring that whenever updates are
deployed, the app will automatically download and install them. You don't need
to manually update the software.
## Can I sync a folder containing multiple subfolders, each representing an album?
Yes, when you drag and drop the folder onto the desktop app, the app will detect
the multiple folders and prompt you to choose whether you want to create a
single album or separate albums for each folder.
## How do I identify which files experienced upload issues within the desktop app?
Check the sections within the upload progress bar for "Failed Uploads," "Ignored
Uploads," and "Unsuccessful Uploads."
## How do I keep NAS and Ente photos synced?
Please try using our CLI to pull data into your NAS
https://github.com/ente-io/ente/tree/main/cli#readme.
## Is there a way to view all albums on the map view?
Currently, the Ente mobile app allows you to see a map view of all the albums by
clicking on "Your map" under "Locations" on the search screen.
## How to reset my password if I lost it?
On the login page, enter your email and click on Forgot Password. Then, enter your recovery key and create a new password.
# iOS Album Backup and Organization in Ente
### How does Ente handle photos that are part of multiple iOS albums?
When you select multiple albums for backup, Ente prioritizes uploading each photo to the album with the fewest photos. This means a photo will only be uploaded once, even if it exists in multiple albums on your device. If you create new albums on your device after the initial backup, those photos may not appear in the corresponding Ente album if they were already uploaded to a different album.
### Why don’t all photos from a new iOS album appear in the corresponding Ente album?
If you create a new album on your device after the initial backup, the photos in that album may have already been uploaded to another album in Ente. To fix this, go to the "On Device" album in Ente, select all photos, and manually add them to the corresponding album in Ente.
### What happens if I reorganize my photos in the iOS Photos app after backing up?
Reorganizing photos in the iOS Photos app (e.g., moving photos to new albums) won’t automatically reflect in Ente. You’ll need to manually add those photos to the corresponding albums in Ente to maintain consistency.

33
docs/docs/photos/faq/hidden-and-archive.md Normal file
View File

@ -0,0 +1,33 @@
---
title: Can I hide photos in ente?
description: Two related ways of hiding or archiving in Ente Photos
---
# Can I hide photos in ente?
Yes, you can hide specific photos and videos in Ente using the "Hide" action.
Open the photo, expand the overflow menu and select Hide (the action with the
eye icon).
Hidden items do not appear anywhere in Ente except within the special "Hidden"
category. Ente will ask for the device biometric (FaceID / TouchID) or passcode
to view the contents of the Hidden category.
You can reach the Hidden category from the bottom of the albums screen.
Keep in mind that hidden items will still show up in the "On device" albums
within Ente as long as they are present in your native gallery. But once you
remove them from your device, they'll stop showing up here.
For more details, see [features/hide](/photos/features/hide).
### Archive
There is also a related feature called "Archive". While hidden items do not
appear anywhere, archived items do not appear in your timeline but can otherwise
be seen within the album and search results.
This is useful when you're not trying to hide certain photos per se, but just do
not want some of them (say, some old screenshots) to clutter your home timeline.
For more details, see [features/archive](/photos/features/archive).

94
docs/docs/photos/faq/installing.md Normal file
View File

@ -0,0 +1,94 @@
---
title: Installing Ente Photos
description: Steps to install Ente Photos
---
# Android
Our Android apps are distributed over the following channels.
### PlayStore
You can install Ente directly from
[PlayStore](https://play.google.com/store/apps/details?id=io.ente.photos).
### F-Droid
Reproducible builds for Ente are available on
[F-Droid](https://f-droid.org/packages/io.ente.photos.fdroid/).
> [!NOTE]
>
> Releases over F-Droid are generally slower since they run their own build
> servers. You can donate to F-Droid [here](https://f-droid.org/en/donate).
### GitHub
Latest releases are built straight from the source and made available over
[GitHub](https://github.com/ente-io/ente/releases?q=tag%253Aphotos-v0).
These builds will notify you whenever a new release is available and will help
you stay updated.
### Obtainium
You can setup [Obtainium](https://github.com/ImranR98/Obtainium) to track our
GitHub releases by
[clicking this link](https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/%7B%22id%22%3A%22io.ente.photos.independent%22%2C%22url%22%3A%22https%3A%2F%2Fgithub.com%2Fente-io%2Fente%22%2C%22author%22%3A%22ente-io%22%2C%22name%22%3A%22Ente%20Photos%22%2C%22preferredApkIndex%22%3A0%2C%22additionalSettings%22%3A%22%7B%5C%22includePrereleases%5C%22%3Afalse%2C%5C%22fallbackToOlderReleases%5C%22%3Atrue%2C%5C%22filterReleaseTitlesByRegEx%5C%22%3A%5C%22%5C%22%2C%5C%22filterReleaseNotesByRegEx%5C%22%3A%5C%22%5C%22%2C%5C%22verifyLatestTag%5C%22%3Afalse%2C%5C%22dontSortReleasesList%5C%22%3Atrue%2C%5C%22useLatestAssetDateAsReleaseDate%5C%22%3Afalse%2C%5C%22releaseTitleAsVersion%5C%22%3Afalse%2C%5C%22trackOnly%5C%22%3Afalse%2C%5C%22versionExtractionRegEx%5C%22%3A%5C%22%5C%22%2C%5C%22matchGroupToUse%5C%22%3A%5C%22%5C%22%2C%5C%22versionDetection%5C%22%3Atrue%2C%5C%22releaseDateAsVersion%5C%22%3Afalse%2C%5C%22useVersionCodeAsOSVersion%5C%22%3Afalse%2C%5C%22apkFilterRegEx%5C%22%3A%5C%22ente-photos*%5C%22%2C%5C%22invertAPKFilter%5C%22%3Afalse%2C%5C%22autoApkFilterByArch%5C%22%3Atrue%2C%5C%22appName%5C%22%3A%5C%22%5C%22%2C%5C%22shizukuPretendToBeGooglePlay%5C%22%3Afalse%2C%5C%22allowInsecure%5C%22%3Afalse%2C%5C%22exemptFromBackgroundUpdates%5C%22%3Afalse%2C%5C%22skipUpdateNotifications%5C%22%3Afalse%2C%5C%22about%5C%22%3A%5C%22%5C%22%7D%22%2C%22overrideSource%22%3Anull%7D)
to add it instantly.
Alternatively, you can follow these steps:
1. Click **Add App** to open a new app config screen
2. Enter `https://github.com/ente-io/ente` in the **App Source URL** field
3. Enable the **Retain release order** from API toggle
4. Scroll down to the **Filter APKs by Regular Expression** field and enter
`ente-photos*`
5. Enable the **Attempt to filter APKs by CPU architecture** if possible toggle
6. Select any applicable app category labels you may have setup
7. Enable the **Try inferring app ID from source code** toggle
8. Scroll back to the top and click **Add** to complete the setup
<br/>
---
<br/>
# iOS
You can install Ente on Apple devices from
[AppStore](https://apps.apple.com/app/id1542026904).
<br/>
---
<br/>
# Desktop
You can grab the latest version of Ente for Mac, Windows and Linux from
[ente.io/download/desktop](https://ente.io/download/desktop).
<br/>
---
<br/>
# Web
Latest versions of our web app are available at
[web.ente.io](https://web.ente.io).
<br/>
---
<br/>
# CLI
Ente's CLI is distributed directly over
[GitHub](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0).

161
docs/docs/photos/faq/metadata.md Normal file
View File

@ -0,0 +1,161 @@
---
title: Metadata
description: Handling of metadata in Ente Photos
---
# Metadata
This document describes Ente's handling of metadata
## Import
Ente will import the date for your photos from three places:
1. Exif
2. Metadata JSON
3. File name
### Exif
Normally, Ente app tries to read the date of the photo from the Exif and other
metadata (e.g. XMP, IPTC) embedded in the file.
> [!TIP]
>
> You can see all of the Exif metadata embedded within a photo by using the
> "View all Exif data" option in the info panel for the photo in Ente.
### Importing from Google takeout
In case of photos exported from Google Photos, the metadata is not embedded
within the file itself, but is instead present in a separate sidecar ".json"
file. Ente knows how to read these files, and in such cases can pick up the
metadata from them.
When you export your data using a Google takeout, Google provides you both your
photos and their associated metadata JSON files. However, for incomprehensible
reasons, they split the JSON and photo across zip files. That is, in some cases
if you have a file named `flower.jpeg`, which has an associated metadata JSON
file named `flower.json`, Google will put the `.jpeg` and the `.json` in
separate takeout zips, and Ente will be unable to correlate them.
To avoid such issues, **we [recommend](/photos/migration/from-google-photos/)
unzipping all of your Google takeout zips into a single folder, and then
importing that folder into Ente**. This way, we will be able to always correctly
map, for example, `flower.jpeg` and `flower.json` and show the same date for
`flower.jpeg` that you would've seen within Google Photos.
### File name
In case the photo does not have a date in the Exif data (and it is not a Google
takeout), for example, for screenshots or Whatsapp forwards, Ente will still try
and deduce the correct date for the file from the name of the file.
> [!NOTE]
>
> This process works great most of the time, but it is inherently based on
> heuristics and is not exact.
If we are unable to decipher the creation time from these 3 sources, we will set
the upload time as the photo's creation time.
## Modifications
Ente supports modifications to the following metadata:
- File name
- Date & time
- Location
The first two options are available on both mobile and desktop, while the
ability to update location is only available within our mobile apps.
### Bulk modifications
You can bulk-edit creation time of photos from our desktop app, by
multi-selecting items and selecting the "Fix time" option from the action bar.
You can bulk-edit location coordinates of photos from our mobile app, by
multi-selecting items and selecting the "Edit location" option from the action
bar.
## Export
Ente guarantees that you will get back the _exact_ same original photos and
videos that you imported. The modifications (e.g. date changes) you make within
Ente will be written into a separate metadata JSON file during export so as to
not modify the original.
As an example: suppose you have `flower.png`. When you export your library, you
will end up with:
```
flower.png
metadata/flower.png.json
```
Ente writes this JSON in the same format as Google Takeout so that if a tool
supports Google Takeout import, it should be able to read the JSON written by
Ente too.
> One small difference is that, to avoid clutter, Ente puts the JSON in the
> `metadata/` subfolder, while Google puts it next to the file.<br>
>
> <br>Ente itself will read it from either place.
Here is a sample of how the JSON would look:
```json
{
"description": "This will be imported as the caption",
"creationTime": {
"timestamp": "1613532136",
"formatted": "17 Feb 2021, 03:22:16 UTC"
},
"modificationTime": {
"timestamp": "1640225957",
"formatted": "23 Dec 2021, 02:19:17 UTC"
},
"geoData": {
"latitude": 12.004170700000001,
"longitude": 79.8013945
}
}
```
`photoTakenTime` will be considered as an alias for `creationTime`, and
`geoDataExif` will be considered as a fallback for `geoData`.
### File creation time.
The photo's data will be preserved verbatim, however when it is written out to
disk on a new machine a new file gets created. This file will not have the same
file system creation time as the file that was uploaded.
1. "Creation time" is not a universal concept, e.g. Linux does not support it.
From the man page of [fstat](https://linux.die.net/man/2/fstat), we can see
that this information is just not recorded by the file system on Linux.
2. The isn't a way to set it even on Windows and macOS for files downloaded from
the browser, or for files saved from the mobile apps.
We have considered modifying our desktop and CLI clients to write back the
photo's creation time into the creation time of the filesytem file during
export. But it is not clear if this would be less or more confusing. There are
two main downsides:
1. It will be inconsistent. This behaviour would only happen on Windows and
macOS, and only when using the desktop or CLI, not for other Ente clients.
Learning from our experience of modifying DateTimeOriginal, we feel
consistency is important.
2. It will require workarounds. e.g. for the desktop app, Node.js doesn't
natively support modifying the creation time (for similar reasons as
described above), and we will have to include binary packages like
[utimes](https://github.com/baileyherbert/utimes).
We will also note that Ente is a photos app, not a file system backup app. The
customers for whom the creation time of the file on disk is paramount might be
better served by file backup apps, not a photos app.
All this said though, nothing is set in stone. If enough customers deem it
important, we will prioritize adding support for the workaround.

137
docs/docs/photos/faq/security-and-privacy.md Normal file
View File

@ -0,0 +1,137 @@
---
title: Security and Privacy FAQ
description:
Comprehensive information about security and privacy measures in Ente Photos
---
# Security and Privacy FAQ
Welcome to Ente Photos' Security and Privacy FAQ. This document provides
detailed information about our security practices, privacy measures, and how we
protect your data. We are committed to maintaining the highest standards of data
protection and transparency.
## Data Encryption and Storage
### Can Ente see my photos and videos?
No. Your files are encrypted on your device before being uploaded to our
servers. The encryption keys are derived from your password using advanced key
derivation functions. Since only you know your password, only you can decrypt
your files. For technical details, please see our
[architecture document](https://ente.io/architecture).
### How is my data encrypted?
We use the following encryption algorithms:
- Encryption: `XChaCha20` and `XSalsa20`
- Authentication: Poly1305 message authentication code (MAC)
- Key derivation: Argon2id with high memory and computation parameters
These algorithms are implemented using
[libsodium](https://libsodium.gitbook.io/doc/), a externally audited
cryptographic library. Our [architecture document](https://ente.io/architecture)
provides full technical specifications.
### Where is my data stored?
Your encrypted data is stored redundantly across multiple providers in the EU:
- Amsterdam, Netherlands
- Paris, France
- Frankfurt, Germany
We use a combination of object storage and distributed databases to ensure high
availability and durability. Our
[reliability document](https://ente.io/reliability) provides in-depth
information about our storage infrastructure and data replication strategies.
In short, we store 3 copies of your data, across 3 different providers, in 3
different countries. One of them is in an underground fall-out shelter in Paris.
### How does Ente's encryption compare to industry standards?
Our encryption model goes beyond industry standards. While many services use
server-side encryption, we implement end-to-end encryption. This means that even
in the unlikely event of a server breach, your data remains protected.
## Account Security
### What happens if I forget my password? {#account-recovery}
If you are logged into Ente on any of your existing devices, you can use that
device to reset your password and use your new password to log in.
If you are logged out of Ente on all your devices, you can reset your password
using your recovery key that was provided to you during account creation.
If you are logged out of Ente on all your devices and you have lost both your
password and recovery key, we cannot recover your account or data due to our
end-to-end encrypted architecture.
If you wish to delete your account in such scenarios, please reach out to
support@ente.io and we will help you out.
### Can I change my password?
Yes, you can change your password at any time from our apps. Our architecture
allows password changes without re-encrypting your entire library.
The privacy of your account is a function of the strength of your password,
please choose a strong one.
### Do you support two-factor authentication (2FA)?
Yes, we recommend enabling 2FA for an additional layer of security. We support:
- Time-based One-Time Passwords (TOTP)
- WebAuthn/FIDO2 for hardware security keys
You can set up 2FA in the settings of our mobile or desktop apps.
## Sharing and Collaboration
### How does sharing work?
The information required to decrypt an album is encrypted with the recipient's
public key such that only they can decrypt them.
You can read more about this [here](https://ente.io/architecture#sharing).
In case of sharable links, the key to decrypt the album is appended by the
client as a [fragment to the URL](https://en.wikipedia.org/wiki/URI_fragment),
and is never sent to our servers.
Please note that only users on the paid plan are allowed to share albums. The
receiver just needs a free Ente account.
## Security Audits
## Has the Ente Photos app been audited by a credible source?
Yes, Ente Photos has undergone a thorough security audit conducted by Cure53, in
collaboration with Symbolic Software. Cure53 is a prominent German cybersecurity
firm, while Symbolic Software specializes in applied cryptography. Please find
the full report here: https://ente.io/blog/cryptography-audit/
## Account Management
### How can I delete my account?
You can delete your account at any time by using the "Delete account" option in
the settings. For security reasons, we request you to delete your account on
your own instead of contacting support to ask them to delete your account.
Note that both Ente Photos and Ente Auth data will be deleted when you delete
your account (irrespective of which app you delete it from) since both photos
and auth use the same underlying account.
To know details of how your data is deleted, including when you delete your
account, please see https://ente.io/blog/how-ente-deletes-data/.
## Additional Support
For any security or privacy questions not covered here, please contact our team
at security@ente.io. We're committed to addressing your concerns and
continuously improving our security measures.

194
docs/docs/photos/faq/subscription.md Normal file
View File

@ -0,0 +1,194 @@
---
title: Subscription FAQ
description: Frequently asked questions about Ente Photos subscription and plans
---
# Subscription and plans
See our [website](https://ente.io#pricing) for the list of supported plans and
pricing.
## Does Ente have Family Plans?
Yes we do! Please check out our announcement post
[here](https://ente.io/blog/family-plans).
In brief,
- Your family members can use storage space from your plan without paying extra.
- Ask them to sign up for Ente, and then just add them to your existing plan
using the "Manage family" option within your Subscription settings.
- Each member gets their own private space, and cannot see each other's files
unless they're shared.
- You can invite 5 family members. So including yourself, it will be 6 people
who can share a single subscription, paying only once.
Note that family plans are meant as a way to share storage. For sharing photos,
you can create [shared albums and links](/photos/features/share).
## Does Ente offer discounts to students?
Yes we do!
We believe that privacy should be made accessible to everyone. In this spirit,
we offer **30% off** our subscription plans to students.
To apply for this discount, please verify your enrollment status in a school /
college / university by writing to [students@ente.io](mailto:students@ente.io)
from the email address assigned to you by your institute.
In case you do not have access to such an email address, please send us proof
(such as your institute's identity card) that verifies your identity as a
student.
Please note that these discounts are valid for a year, after which you may
reapply to reclaim the discount.
## What payment methods does Ente support?
On Web, Desktop and Android, Stripe helps us process payments from all major
prepaid and credit card providers.
On iOS, we (have to) use the billing platforms provided by the app store.
Apart from these, we also support PayPal and crypto currencies (more details
below).
## Can I pay with PayPal?
We support **annual** subscriptions over PayPal.
Please drop an email to paypal@ente.io from your registered email address,
mentioning the [storage plan](https://ente.io#pricing) of your choice and we
will send you an invoice with a link to complete the payment.
Once the payment is completed, your account will be upgraded to the chosen plan.
## Does Ente accept crypto payments?
We accept the following crypto currencies:
- Bitcoin
- Ethereum
- Dogecoin
To purchase a subscription with any of the above mentioned currencies, please
write to crypto@ente.io from your registered email address, citing the
[storage plan](https://ente.io#pricing) of your choice.
In case you have any further questions or need support, please reach out to
[support@ente.io](mailto:support@ente.io), and we'll be happy to help!
> Please note that Ente does not provide anonymity. What we provide is privacy,
> since your data is end-to-end encrypted.
> [Information](https://ente.io/privacy/#3-what-information-do-we-collect) we
> have about you might make your identity deducible. We are accepting crypto as
> a way to make Ente more accessible, not to provide anonymity.
## Does Ente store my card details?
Ente does not store any of your sensitive payment related information.
We use [Stripe](https://stripe.com) to handle our card payments, and all of your
payment information is sent directly to Stripe's PCI DSS validated servers.
Stripe has been audited by a PCI-certified auditor and is certified to
[PCI Service Provider Level 1](https://www.visa.com/splisting/searchGrsp.do?companyNameCriteria=stripe).
This is the most stringent level of certification available in the payments
industry.
All of this said, if you would still like to pay without sharing your card
details, you can pay using PayPal.
## What happens if I exceed my storage limit?
Ente will stop backing up your files and you will receive an email alerting you
of the same.
Your backed up files will remain accessible for as long as you have an active
subscription.
## What happens when my subscription expires?
30 days after your subscription expires, all of your uploaded data will be
cleared from our servers.
You will receive an email prompting you to take out all of your backed up data
before this happens.
## What happens when I upgrade my plan?
Your new plan will go into effect immediately, and you only have to pay the
difference. We will adjust your remaining pro-rated balance on the old plan when
invoicing you for the new plan.
For example, if you are half way through the year on the 50 GB yearly plan, and
upgrade to the 200 GB yearly plan, then
- The new 200 GB yearly plan will go into effect immediately.
- But we will reduce the charges for the first year by subtracting the remaining
half year balance of the 50 GB yearly plan that you'd already paid.
The same applies to monthly plans.
## What happens when I downgrade my plan?
Your new plan will go into effect immediately. Any extra amount you have paid
will be credited to your account. This credit will be discounted from your
future invoices.
For example, if you are half way through the year on the 200 GB yearly plan, and
downgrade to the 50 GB yearly plan, then
- The new 50 GB yearly plan will go into effect immediately.
- We will calculate a credit by subtracting half the price of the 50 GB plan
from half the price of the 200 GB plan. This will be credited to your account.
- This credited amount will be discounted from your next invoice, which will be
due in half a year.
The same applies to monthly plans.
If you prefer to have this credit refunded to your original payment method,
please contact support@ente.io, and we'll assist you.
## How can I update my payment method?
You can view and manage your payment method by clicking on the green
subscription card within the Ente app, and selecting the "Manage payment method"
button.
You will be able to see all of your previous invoices, with details regarding
their payment status. In case of failed payments, you will also have an option
to retry those charges.
## How can I cancel my subscription?
You can cancel your subscription by clicking on the green subscription card
within the Ente app, and selecting the "Cancel subscription" button.
## Is there an x GB plan?
We have experimented quite a bit and have found it hard to design a single
structure that fits all needs. Some customers wish for many options, some even
wish to go to an extreme of dynamic per GB pricing. Other customers wish to keep
everything simple, some even wish for a single unlimited plan.
To keep things fair, our plans don't increase linearly, and the tiers are such
that cover the most requested patterns.
In addition, we also offer [family plans](/photos/features/family-plans) so that
you can gain more value out of a single subscription.
## Is there a forever-free plan?
Yes, we offer 5 GB of storage for free.
## What are the limitations of the free plan?
You cannot share albums, or setup a family while you are on a free plan.

63
docs/docs/photos/faq/video-streaming.md Normal file
View File

@ -0,0 +1,63 @@
---
title: Video streaming FAQ
description:
Frequently asked questions about Ente's video streaming feature
---
# Video streaming
> [!NOTE]
>
> Video streaming is available in beta on mobile apps starting v0.9.98.
### How to enable video streaming?
- Open Settings -> General -> Advanced
- Switch on the toggle for `Video streaming`
### What happens when I enable video streaming?
Enabling video streaming will start processing videos captured in the last 30
days, generating streams for each. Both local and remote videos will be
processed, so this may consume bandwidth for downloading of remote files and
uploading of the generated streams.
### How can I view video streams?
Settings -> Backup > Backup status will show details regarding the processing
status for videos. Processed videos will have a green play button next to them.
You can open these videos by tapping on them.
Processed videos will show a `Play stream` button, clicking which will load and
play the stream.
Clicking on the `Info` icon within the original video will show details about
the generated stream.
### What is a stream?
Stream is an encrypted HLS file with an `.m3u8` playlist that helps play a video
with support for seeking **without** downloading the full file.
Currently it converts videos into `720p` with `2mbps` bitrate in `H.264` format.
The generated stream is single blob (encrypted with AES) while the playlist file
(`.m3u8`) is another blob (encrypted using XChaCha20).
We cannot read the contents, duration or the number of chunks within the
generated stream.
### Will streams consume space in my storage?
While this feature is in beta, we will not count the storage consumed by your
streams against your storage quota. This may change in the future. If it does,
we will provide an option to opt-in to one of the following:
1. Original videos only
2. Compressed streams only
3. Both
### Something doesn't seem right, what to do?
As video streaming is still in beta, some things might not work correctly.
Please create a thread within the `#feedback` channel on
[Discord](https://discord.com/channels/948937918347608085/1121126215995113552)
or reach out to [support@ente.io](mailto:support@ente.io).

131
docs/docs/photos/features/albums.md Normal file
View File

@ -0,0 +1,131 @@
---
title: Albums
description: Using albums in Ente Photos
---
# Albums
## Preserving folder structure
When you upload photos and videos into Ente using the desktop app - whether by
dragging and dropping a folder or zip file (or selecting it in the "Upload"
selector), or by setting up a [folder watch](/photos/features/watch-folders) -
the app will provide you various options.
### Uploading files or a folder without nesting
If you are trying to just upload some files, then the app will provide you a
selector where you can choose to (a) uploads all the files to an existing Ente
album, or (b) create a new album.
Similarly, if you upload a folder without any nested folders, than the app will
ask if you want to upload them to an existing Ente album, or create a new album.
The app will also try to intelligently determine the name of the new album.
### Uploading a nested folder
If the folder you're trying to upload has nesting and you select the option to
create a new album, you will see two options - **A single album** and **Separate
albums**.
- **Single album** will create a new Ente album with the same name as the
folder's name, and will then sync all the changes in the folder (and any
nested folders) to this single album.
- **Separate albums** will create separate albums for each nested folder of the
selected folder, and will then sync the changes in each nested folder
separately.
- For example, suppose you have a folder name `Photos` on your computer, and
inside that folder you have two nested folders named `New Year` and `Summer`.
In the single album mode, the app will create an Ente album named "Photos" and
put all the files from both `New Year` and `Summer` there. In the separate
album mode, the app will create two Ente albums, "New Year" and "Summer", each
only containing the respective files.
- In separate album mode, only nested folders that have at least one file will
result in the creation of a new album – empty folders (or folders that only
contain other folders) will be ignored.
- In separate album mode, only the leafmost folder name is considered. For
example, both `A/B/C/D/x.png` and `1/2/3/D/y.png` will get uploaded into the
same Ente album named "D".
> [!NOTE]
>
> Ente albums cannot be nested currently. That is, in the **separate album**
> mode described above, Ente will create a separate album for each nested
> folder, but these Ente albums themselves will not be nested.
## Rename album
Personalize your albums by giving them a meaningful name.
### How to rename an album on your mobile?
- Open the album
- Tap the three dots button in the top right corner of the screen
- Tap _Rename album_, then type in a new name
- Tap on _Rename_ button
### How to rename an album on your web / desktop?
- Open the album
- Click on the overflow menu in the top right corner
- Click the _Rename album_ button
- Type in a new name
- Click on _Rename_ or press enter
## Set album cover
Select any photo you want to use as the cover for your album.
### How to set an album cover on mobile?
- Open the album you want to change
- Tap the three dots button in the top right corner
- From the menu options, select _Set cover_
- A new screen will appear, propmpting you to select the cover photo
- Browse through your photos and tap on the image you want to set as the album
cover
- Then tap on _Use selected photo_
## View your photos on a map
Explore your memories based on their location.
### How to explore the album's photos in map view?
- Open the album
- Tap on the three dots button in the top right corner
- Select _Map_
- This will show all photos of the album in a map view
## Sort albums
Maintain order in your albums by arranging them from the newest to the oldest.
### How to change the sort order on mobile?
- Open the album
- Tap on the three dots button in the top right corner
- Select _Sort by_
- Tap on the _Newest first_ for the latest, Or _Oldest first_ for the oldest
### How to change the sort order on web / desktop?
- Open the album
- Click on the three dots button in the top right corner
- Click _Sort by_
- Tap on the _Newest first_ for the latest, Or _Oldest first_ for the oldest
## Pin albums
Keep your favorite album at the top by pinning them for quick access.
### How to pin/unpin an album on mobile?
- Open the album
- Tap on the three dots button in the top right corner
- Tap on _Pin album_ / _Unpin album_

53
docs/docs/photos/features/archive.md Normal file
View File

@ -0,0 +1,53 @@
---
title: Archive
description: |
Archiving photos and albums in Ente Photos to remove them from your home
timeline
---
# Archive
You can remove a photo (owned by you) or an album from your **home timeline** by
archiving it. Archived photos won't be included in the memories section on the
mobile app.
- All photos within a archived album will be removed from home timeline, even
when some of the photos are also present in a non-archived album.
- You can archive albums that are owned by you or shared with you.
- Search results will include archived photos. If you want to hide photos from
search result, use [Hide](./hide) feature.
## How to
### Archive Album
- Open the album
- Click on the overflow menu
- Click on Archive album
### Archive Photo
- Long press to select the photo
- Select Archive option from the bottom menu.
### View Archived Photos and Albums
#### Mobile
- Go to Albums tab
- Scroll down to bottom
- Click on Archive button.
#### Web / Desktop
- Click on the topleft hamburger menu
- Click on Archive
### Metadata Privacy
Both Ente and the person with whom you are sharing an album or photo have no
information about whether you have:
- Archived a photo
- Archived an album
- Archived a shared album

61
docs/docs/photos/features/background.md Normal file
View File

@ -0,0 +1,61 @@
---
title: Background sync
description: Ente Photos supports automatic background sync and backup
---
# Background sync
Ente Photos supports seamless background sync so that you don't need to open the
app to backup your photos. It will sync in the background and automatically
backup the albums that you have selected for syncing.
Day to day sync will work automatically. However, there are some platform
specific considerations that apply, more on these below:
### iOS
On iOS, if you have a very large number of photos and videos, then you might
need to keep Ente running in the foreground for the first backup to happen
(since we get only a limited amount of background execution time). To help with
this, under "Settings > Backup" there is an option to disable the automatic
device screen lock. But once your initial backup has completed, subsequent
backups will work fine in the background and don't need disabling the screen
lock.
On iOS, Ente will not backup videos in the background (since videos are usually
much larger and need more time to upload than what we get). However, they will
get backed up the next time the Ente app is opened.
Note that the Ente app will not be able to backup in the background if you force
kill the app.
> If you're curious, the way this works is, our servers "tickle" your device
> every once in a while by sending a silent push notification, which wakes up
> our app and gives it 30 seconds to execute a background sync. However, if you
> have killed the app from recents, iOS will not deliver the push to the app,
> breaking the background sync.
### Android
On some Android versions, newly downloaded apps activate a mode called "Optimize
battery usage" which prevents them from running in the background. So you will
need to disable this "Optimize battery usage" mode in the system settings for
Ente if you wish for Ente to automatically back up your photos in the
background.
On Android versions 15 and later, if an app is in private space and the private
space is locked, Android doesn’t allow the app to run any background processes.
As a result, background sync will not work.
### Desktop
In addition to our mobile apps, the background sync also works on our desktop
app, though the [way that works](watch-folders) is a bit different.
---
## Troubleshooting
- On iOS, make sure that you're not killing the Ente app.
- On Android, make sure that "Optimize battery usage" is not turned on in system
settings for the Ente app.

22
docs/docs/photos/features/backup.md Normal file
View File

@ -0,0 +1,22 @@
---
title: Backup
description: Details about how backup works in Ente Photos
---
# Backup
Ente will automatically backup any albums in your native photos app that you
select for backup.
Ente will run in the background, and any new photos added to these albums (or
any photos in these albums that were modified) will be automatically synced to
ente.
You can choose which albums should be backed up when you sign up for Ente. If
you change your mind later, or if you create a new album in your native photos
app that you also want to backup, please use "Settings > Backup > Backed up
folders" to modify your choices.
If a file is deleted on your native photos app, it will still show up in Ente.
This is because on both iOS and Android, apps are not allowed to automatically
delete user's photos without a manual confirmation.

59
docs/docs/photos/features/cast/index.md Normal file
View File

@ -0,0 +1,59 @@
---
title: Cast
description:
Casting your photos on to a large screen or a TV or a Chromecast device
---
# Cast
With Ente Cast, you can play a slideshow of your favourite albums on your Google
Chromecast TVs or any other internet-connected large screen devices.
## Get Started
1. Open Ente on the web or on your mobile device.
2. Select the album you want to play on your large screen device.
3. Click "Play album on TV" in the album menu.
On the web, you can find this option in the three dots menu on the right
hand side.
<div align="center">
![Album options menu](web-play-album-on-tv.webp){width=300px}
</div>
4. Choose how you want to pair your device with your large screen device.
<div align="center">
![Pairing options](web-pairing-options.webp){width=300px}
</div>
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 on your local network. Note: this option requires connecting to
Google servers to load necessary dependencies. This option does not transmit
any sensitive data through Google servers, such as your photos. Once your
Chromecast device is connected, you're all set.
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
[cast.ente.io](https://cast.ente.io) on your large screen device.
5. Enter the PIN displayed on your large screen device into the input field on
your mobile or web device.
On your large screen device, you'll see the following screen.
<div align="center">
![Pairing screen](tv-pairing-screen.png)
</div>
6. Once you enter the correct PIN, you will see a screen on your TV with a green
checkmark confirming the connection. Your photos will start showing up in a
bit.

BIN
docs/docs/photos/features/cast/tv-pairing-screen.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/docs/photos/features/cast/web-pairing-options.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 51 KiB

BIN
docs/docs/photos/features/cast/web-play-album-on-tv.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

62
docs/docs/photos/features/collaborate.md Normal file
View File

@ -0,0 +1,62 @@
---
title: Collaboration
description: Collaborate with other people using shared albums and public links
---
# Collaborate
Ente allows you to collaborate with people in 2 ways:
- Collaborative albums
- Collaborative links
## Collaborative albums
Collaborative albums allow multiple Ente users to add photos to the same shared
album. Storage is only counted once, irrespective of the number of collaborators
and viewers.
- The owner of the album is the person who created it.
- The owner can add collaborators and viewers by their email. The owner can also
change permissions of participants at any time, and remove them.
- Collaborators can add photos (and videos) to the shared album.
- The storage of the photo is counted towards the owner of the photo - the
person who uploaded it. Since the uploader usually has the photo in their
account anyway, effectively this means that the photo can be added to a
collaborative album without paying anything extra.
- The owner of the photo can remove it from the album (or delete it).
- The owner of the album can remove all photos from the album (they can only
delete the photos they own).
- When a collaborator is removed from a shared album (or when they leave the
album), any photos they'd uploaded will also be removed.
Currently collaborative albums can only be used from the mobile app. A
collaborator will see them in view only mode in the web and desktop apps; we're
actively working on adding support for them on web and desktop too.
## Collaborative links
Collaborative links allow you to collaborate with people who might not have an
Ente account or the Ente apps.
- You can create a public link, and anyone with access to the link will be able
to view the shared photos using just their web browser (no login required).
- You can enable the "Allow adding photos" option on a public link to allow
people to also add photos the same way (from their web browser, no login
required).
Such collaborative links are also sometimes called "collect links", since they
allow you to collect photos from people without them needing Ente accounts. A
common use case for this is collecting event and trip photos from a big circle
of people.
The storage for the photos added to a collaborative link are counted towards the
album owner. The owner can also remove these photos at any time.

32
docs/docs/photos/features/collect.md Normal file
View File

@ -0,0 +1,32 @@
---
title: Collect
description: Collecting photos from others using Ente Photos
---
# Collect photos
Collecting memories from events is now a breeze!
- Whether it's a birthday party, vacation trip or wedding, easily share your
album using a unique, secure, end-to-end encrypted link.
- Introduce the 'collect photos' feature to your friends and family who can
contribute without an Ente account.
- This allows them to effortlessly add, view, and download photos from the link
without an Ente account.
- Also preserves metadata and photo quality.
## How to collect photos on mobile?
- Open the album you want to share with
- Tap on the Share album icon in the top right corner of the screen
- Select _Collect photos_
- Tap _Copy link_
- The link will get copied to your clipboard. Now, feel free to share it
## How to Collect photos on web / desktop?
- Open the album
- Click on the share album icon
- Select _Collect photos_
- Click on _Copy link_
- The link will get copied to your clipboard. Share it effortlessly with others!

59
docs/docs/photos/features/deduplicate.md Normal file
View File

@ -0,0 +1,59 @@
---
title: Deduplicate
description: Removing duplicates photos using Ente Photos
---
# Deduplicate
Ente performs two different duplicate detections: one during uploads, and one
that can be manually run afterwards to remove duplicates across albums.
## During uploads
Ente will automatically deduplicate and ignore duplicate files during uploads.
When uploading, Ente will ignore exact duplicate files. This allows you to
resume interrupted uploads, or drag and drop the same folder, or reinstall the
app, and expect Ente to automatically skip duplicates and only add new files.
The duplicate detection works slightly different on each platform, to cater to
the platform's nuances.
#### Mobile
- On iOS, a hash will be used to detect exact duplicates. If the duplicate is
being uploaded to an album where a photo with the same hash already exists,
then the duplicate will be skipped. If it is being uploaded to a different
album, then a symlink will be created (so no actual data will need to be
uploaded, just a symlink will be created to the existing file).
- On Android also, a hash check is used. But unlike iOS, the native Android
filesystem behaviour is to keep physical copies if the same photo is in
different albums. So Ente does the same: duplicates to same album will be
skipped, duplicates when going to separate albums will create copies.
#### Web and desktop
On laptops (i.e. when using the Ente web or desktop app), in addition to a hash
check, the file name is also used. The assumption is that the user wishes to
keep two copies if they have the same file but with different names.
Thus a file will be considered a duplicate and skipped during upload if a file
with the same name and hash already exists in the album.
And if you're trying to upload it to a different album (i.e. the same file with
the same name already exists in a different album), then a symlink to the
existing file will be created. This is similar to what happens when you do "Add
to album", and the actual files are not re-uploaded.
## Manual deduplication
Ente also provides a tool for manual de-duplication in _Settings → Backup →
Remove duplicates_. This is useful if you have an existing library with
duplicates across different albums, but wish to keep only one copy.
## Adding to Ente album creates symlinks
Note that once a file is in Ente, adding it to another Ente album will create a
symlink, so that you can add it to as many albums as you wish but storage will
only be counted once.

52
docs/docs/photos/features/family-plans.md Normal file
View File

@ -0,0 +1,52 @@
---
title: Family plans
description:
Share your Ente Photos plan with your family members with no extra cost
---
# Family plans
Paid subscribers of Ente can share the storage with their family, **at no
additional cost** as you have already paid for the storage.
In brief,
- Your family members can use storage space from your plan without paying extra.
- Ask them to sign up for Ente, and then just add them to your existing plan
using the "Manage family" option within your Subscription settings.
- Each member gets their own private space, and cannot see each other's files
unless they're shared.
- You can invite 5 family members. So including yourself, it will be 6 people
who can share a single subscription, paying only once.
## Storage Limits
If you're an admin of a family, you will be able to set storage limits for the
members in your family plan.
In brief,
- For example, once you set a limit of 10GB for a member, their Storage
quota for uploading photos will be limited to 10GB.
- Once the invited member accepts the Family invite, you will be able to see
an edit icon in the Members List. Click on it to setup a family limit.
- If the admin has set a limit for any user, that limit value will be prefilled
in the input box.
- Incase, if you want to remove any storage limit from a members account, you
can click on the "Remove Limit" and they can upload photos without any limit.
## FAQ
- **Can you assign a storage quota for each individual member in the family
plan?**
Unfortunately, at this moment, assigning a storage quota for each individual
member in the family plan is not supported. For updates on this feature
request, please follow
[this thread](https://github.com/ente-io/ente/discussions/857).

BIN
docs/docs/photos/features/free-up-space/free-up-space.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 69 KiB

18
docs/docs/photos/features/free-up-space/index.md Normal file
View File

@ -0,0 +1,18 @@
---
title: Free up space
description: Freeing up your phone's storage space when using Ente Photos
---
# Free up your phone's storage space
Within the app's settings page, you have an option to free up space by deleting
all backed up photos and videos from your phone's internal storage.
<div align="center">
![Free up space screen](free-up-space.png){width=400px}
</div>
> Note: You might have to clear the device's trash to realize this cleared
> space.

66
docs/docs/photos/features/hide.md Normal file
View File

@ -0,0 +1,66 @@
---
title: Hiding photos and albums
description: Hide photos and albums in Ente Photos
---
# Hiding photos and albums
You can further protect extra sensitive photos or albums by hiding them. Hidden
photos or albums will **only be viewable** after an extra layer of
authentication inside the app. Hiding differs from [Archiving](./archive.md) in
that the hidden photos won't be surfaced anywhere in the app without explicit
authentication, whereas archiving only removes them from the home timeline and
memories sections.
- Hidden photos and albums will be removed from home timelines, memories, albums
tab, search results, and any other visable place in the app.
- Hidden photos will be removed from all regular albums. If you want to unhide
again you will have to specify the album to move it to.
- You cannot hide photos or albums shared with you. You can archive shared
albums instead.
## How to
### Hide album
- Open the album
- Click on the overflow menu
- Click on _Hide album_
### Hide photo
- Select the photo
- Click on _Hide_ option from the select menu
### View hidden photos and albums
#### Mobile
- Go to Albums tab
- Scroll down to bottom
- Click on _Hidden_ button
- Authenticate in app
#### Web / Desktop
- Click on the topleft hamburger menu
- Click on _Hidden_
- Authenticate in app
### Unhide album
- Open the hidden album
- Click on the overflow menu
- Click on _Unhide album_
### Unhide photo
- Select the hidden photo
- Click on _Unhide_ option from the select menu
- Click on the album the photo should be restored to
## Metadata Privacy
Ente has no information about whether you have hidden a photo or album.

BIN
docs/docs/photos/features/legacy/accept_trusted_contact_invite.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB

BIN
docs/docs/photos/features/legacy/add_trusted_contact.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

69
docs/docs/photos/features/legacy/index.md Normal file
View File

@ -0,0 +1,69 @@
---
title: Legacy
description: Using Legacy to pass on your memories to loved ones
---
# Legacy
Legacy allows trusted contacts to recover your account in your absence. The main
usecase here is to pass on your memories after your death. It can also be useful
for other cases - for e.g., when you forget your password and recovery key.
Trusted Contacts can initiate a recovery, and if not blocked in 30 days, would
be able to change the password to your account and thereby access your memories.
## Adding a trusted contact
You can add a trusted contact for your account using the mobile app for Ente
Photos. Go to Settings -> Account -> Legacy, and click on "Add Trusted Contact".
You would be asked to enter the email address of the trusted contact you want to
add or choose from a list of contacts on Ente. Please note that the trusted
contact must be an Ente user.
<div align="center">
![Add Trusted Contact](add_trusted_contact.png){width=300px}
</div>
The trusted contact must accept your request. They can do so by going to
Settings -> Account -> Legacy in the Ente Photos mobile app, and clicking on
your email address within the Legacy accounts sections. Ente would also send an
email notification to the trusted contact to nudge them to accept the invite.
<div align="center">
![Accept Trusted Contact Invite](accept_trusted_contact_invite.png){width=300px}
</div>
## Recovering an account as a trusted contact
As a trusted contact, you can recover an account by going to Settings -> Account
-> Legacy in the Ente photos app, tapping on the email address of the account
within the Legacy account sections.
<div align="center">
![Initiate Account Recovery](initiate_account_recovery.png){width=300px}
</div>
Once the recovery is initiated, the account owner would get 30 days to block the
recovery. After 30 days, you can go the same page in the app, where you will be
prompted to change the password of the account. Once you change the password,
you would be able to access the recovered account with the new password.
## Blocking account recovery by a trusted contact
After a trusted contact initiates a recover, you, as the account owner, would
get 30 days to block the recovery. To do this, you must go to Settings ->
Account -> Legacy, where you will see a message that recovery of the account has
been initiated. Tapping on that will allow you to block the recovery.
## Removing a trusted contact
You can remove a trusted contact by going to Settings -> Account -> Legacy,
tapping on the trusted contact you want to remove, and choosing "Remove" in the
popup.

BIN
docs/docs/photos/features/legacy/initiate_account_recovery.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

43
docs/docs/photos/features/location-tags.md Normal file
View File

@ -0,0 +1,43 @@
---
title: Location tags
description: Search and organize your photos by location in Ente Photos
---
# Location Tags
_Search and organize your photos by their location_
Location Tags allow you to search and organize your photos based on their
geographical location. Instead of sending your queries to our servers, we've
implemented a privacy-friendly solution that runs searches locally on your
device.
## How to use Location Tags
### Method 1: Adding Location Tags from a Photo
1. Open a photo
2. Click on _Info_
3. Select _Add Location_"
4. Enter the location name and define a radius
### Method 2: Adding Location Tags from the Search Tab
1. Go to the search tab
2. Click on _Add new_ at the end of the location tags section
3. Select a photo as the center point for the location tag
4. Enter the location name and define a radius
## Tips
- The app will automatically cluster photos falling within a radius under a
specified location.
- Location Tags provide a seamless way to filter photos without compromising
your privacy.
- Location tags are stored end-to-end encrypted, ensuring the security of your
data.
- Enjoy a more organized photo library by tagging important places like home,
office, and vacation spots.

54
docs/docs/photos/features/machine-learning.md Normal file
View File

@ -0,0 +1,54 @@
---
title: Machine learning
description:
Ente supports on-device machine learning for face and natural language
search
---
# Machine learning
Ente supports on-device machine learning. This allows you to use the latest
advances in AI in a privacy preserving manner.
- You can search for your photos by the **Faces** of the people in them. Ente
will show you all the faces in a photo, and will also try to group similar
faces together to create clusters of people so that you can give them names,
and quickly find all photos with a given person in them.
- You can search for your photos by typing natural language descriptions of
them. For example, you can search for "night", "by the seaside", or "the red
motorcycle next to a fountain". Within the app, this ability is referred to as
**Magic search**.
You can enable face recognition and magic search in the app's preferences on
either the mobile app or the desktop app.
On mobile, this is available under `General > Advanced > Machine learning`.
On desktop, this is available under `Preferences > Machine learning`.
---
The app needs to download your original photos to index them. This is faster
over WiFi. Indexing is also faster on your computer as compared to your mobile
device.
> [!TIP]
>
> If you have a large library on Ente, we recommend enabling this feature on the
> desktop app first, because it can index your existing photos faster. Once your
> existing photos have been indexed, then you can use either. The mobile app is
> fast enough to index new photos as they are being backed up.
>
> Also, it is beneficial to enable machine learning before importing your
> photos, as this allows the Ente app to index your files as they are getting
> uploaded instead of needing to download them again.
The indexes are synced across all your devices automatically using the same
end-to-end encrypted security that we use for syncing your photos.
Note that the desktop app does not currently support modifying the face
groupings, that is only supported by the mobile app.
For more information on how to use Machine Learning for face recognition please
check out [the FAQ](../faq/face-recognition).

38
docs/docs/photos/features/map.md Normal file
View File

@ -0,0 +1,38 @@
---
title: Maps
description: View and explore your photos on a map within Ente Photos
---
# Map
_View and explore your photos on the map_
## How can I view photos on the map on mobile?
- Find the search icon located at the bottom right corner of your screen.
- Tap on the globe icon (Your map) withing the location
- Enter the map view and start exploring your photos from around the world.
## How to enable map on your mobile app?
- Tap the three horizontal lines located at the top left corner of your home
screen or swipe left on the home screen.
- Select _General_ settings.
- Enter the _Advanced_ settings.
- Use the toggle switch to turn the map feature on or off.
## How to view Album photos on the map?
- Open the album containing the photos you want to view
- Tap on the three horizontal lines located in the top right corner of the
screen.
- Select _Map_ from the options.
- View and explore your photos on the map.
## How to enable map on desktop?
- Click on the three horizontal lines located in the top left corner of the app.
- Navigate to _Preferences_ from the menu.
- Select _Advanced_ in the preferences menu.
- Click on _Map_ to access map settings.
- Toggle the map settings on and off based on your preferences.

64
docs/docs/photos/features/passkeys.md Normal file
View File

@ -0,0 +1,64 @@
---
title: Passkeys
description: Using passkeys as a second factor for your Ente account
---
# Passkeys
Passkeys are a new authentication mechanism that uses strong cryptography built
into devices, like Windows Hello or Apple's Touch ID. **You can use passkeys as
a second factor to secure your Ente account.**
> [!TIP]
>
> Passkeys are the colloquial term for a WebAuthn (Web Authentication)
> credentials.
>
> - More details about why and how are in the Passkeys announcement
> [blog post](https://ente.io/blog/introducing-passkeys-on-ente/).
> - And to know more technical details about how our passkey verification works,
> you can see this
> [technical note in our source code](https://github.com/ente-io/ente/blob/main/web/docs/webauthn-passkeys.md).
## Passkeys and TOTP
Ente already supports TOTP codes (in fact, we built an
[entire app](https://ente.io/auth/) to store them...). Passkeys serve as an
alternative 2FA (second factor) mechanism.
If you add a passkey to your Ente account, it will be used instead of any
existing 2FA codes that you have configured (if any).
## Enabling and disabling passkeys
Passkeys get enabled if you add one (or more) passkeys to your account.
Conversely, passkeys get disabled if you remove all your existing passkeys.
To add and remove passkeys, use the _Passkey_ option in the settings menu. This
will open up _accounts.ente.io_, where you can manage your passkeys.
## Login with passkeys
If passkeys are enabled, then _accounts.ente.io_ will automatically open when
you log into your Ente account on a new device. Here you can follow the
instructions given by the browser to verify your passkey.
> These instructions different for each browser and device, but generally they
> will ask you to use the same mechanism that you used when you created the
> passkey to verify it (scanning a QR code, using your fingerprint, pressing the
> key on your Yubikey or other security key hardware etc).
## Recovery
If you are unable to login with your passkey (e.g. if you have misplaced the
hardware key that you used to store your passkey), then you can **recover your
account by using your Ente recovery key**.
During login, press cancel on the browser dialog to verify your passkey, and
then select the "Recover two-factor" option in the error message that gets
shown. This will take you to a place where you can enter your Ente recovery key
and login into your account. Now you can go to the _Passkey_ page to delete the
lost passkey and/or add a new one.
If you have lost access to both your passkey and recovery key, please reach out
to [support@ente.io](mailto:support@ente.io) for help.

27
docs/docs/photos/features/public-link.md Normal file
View File

@ -0,0 +1,27 @@
---
title: Public link
description:
Share photos with your friends and family without them needing to install
Ente Photos
---
# Public link
Ente lets you share your photos via links, that can be accessed by anyone,
without an app or account.
The contents within these links are also end-to-end encrypted.
> Implementation details have been documented
> [here](https://ente.io/blog/building-shareable-links/).
You can also use these links to collect photos from your friends after a party
or event. Everything they add also remains end-to-end encrypted.
In addition to this, links support the following features:
- Link expiry (so the links go poof after a duration you define)
- Device limits (in case you don't want someone to forwarding your link)
- Password lock (to add an additional level of protection to your photos)
- Prevent downloads (while we can't prevent screenshots, we can disable the
option to download your original photos)

22
docs/docs/photos/features/quick-link.md Normal file
View File

@ -0,0 +1,22 @@
---
title: Quick link
description: Share photos with your friends and family without creating albums
---
# Quick link
Quick links allows you to select single or multiple photos and create a link
that you can then share. You don't need to create an album first.
> Behind the scene, Ente creates a special album and put all the selected files
> in that special album.
- You can view all quick links created by you in the sharing tab, under Quick
links section.
- Quick links can be converted to regular album.
- Removing a link will not delete the photos that are present in that link.
- Similar to a [public-link](./public-link), you can set link expiry, passwords
or device limits.

BIN
docs/docs/photos/features/referral-program/free-storage.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 102 KiB

62
docs/docs/photos/features/referral-program/index.md Normal file
View File

@ -0,0 +1,62 @@
---
title: Referral program
description: Earn free storage by referring Ente Photos to your friends
---
# Referral program
You can refer your friends to earn free storage on Ente.
For each friend you refer, who upgrades to a paid plan, we will credit **10 GB**
of free storage. The referred customer will also receive an additional **10 GB**
with their paid subscription.
That is, if you refer a friend, once your friend upgrades to a paid plan, both
you and your friend receive an additional 10 GB of storage.
You can find your referral code under _Settings → General → Referrals_.
<div align="center">
![Claim free storage screen](free-storage.png){width=400px}
</div>
### How much storage can I earn?
The amount of free storage you can earn is capped to your current plan. This
means, you can at max <u>double your storage</u>. For example, if you're on a
100 GB plan, you can earn another 100 GB (by referring 10 friends), taking your
total available storage to 200 GB.
You can keep track of your earned storage and referral details on _Claim free
storage_ screen.
If you refer more paid customers than is allowed by your current plan, the extra
storage earned will be reserved and will become usable once you upgrade your
plan.
### For how long do I have access to this storage?
Earned storage will be accessible as long as your subscription is active,
provided there has been no abuse.
In case our systems detect abuse, we may notify you and take back credited
storage. Low quality referrals (who don't renew their plans) or creation of fake
accounts, etc. could result in this.
### How can my friends apply my referral code?
Referral codes can be applied within _Settings → General → Referrals → Apply
Code_.
<div align="center">
![Apply referral code screen](referral-code-application.png){width=400px}
</div>
---
More questions? Drop a mail to [referrals@ente.io](mailto:referrals@ente.io),
and we'll get back to you!

BIN
docs/docs/photos/features/referral-program/referral-code-application.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 90 KiB

100
docs/docs/photos/features/share.md Normal file
View File

@ -0,0 +1,100 @@
---
title: Share
description: Securely share photos and videos stored in Ente Photos
---
# Sharing
Ente supports end-to-end encrypted sharing of your photos and videos.
This allows you to share your photos and videos with only the people you want,
without them being visible to anybody else. The files remain encrypted at all
times, and only the people you have shared with get the decryption keys.
- If the person you want to share with is already on Ente, you can share an
album with them by entering their email address.
- If they are not already on Ente, you can send them an invite and then share
with them after they've signed up.
- Alternatively, you can create public links to share albums with people who are
not on Ente.
With public links, the files are still end-to-end encrypted, so the sharing is
still secure. Note that the decryption keys are part of the public link so keep
in mind that anybody with the link will be able to share it with others.
Both shared albums and public links allow [collaboration](collaborate).
## Links
You can create links to your albums by opening an album and clicking on the
Share icon. They are publicly accessible by anyone who you share the link with.
They don't need an app or account.
These links can be password protected, or set to expire after a while.
You can read more about the features supported by Links
[here](https://ente.io/blog/powerful-links/).
## Albums
If your loved ones are already on Ente, you can share an album with their
registered email address.
If they are your partner, you can share your `Camera` folder on Android, or
`Recents` on iOS. Whenever you click new photos, they will automatically be
accessible on your partner's device.
## Collaboration
You can allow other Ente users to add photos to your album. This is a great way
for you to build an album together with someone. You can control access to the
same album - someone can be added as a `Collaborator`, while someone else as a
`Viewer`.
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
access to the link will be able to add photos to your album.
## Organization
You can favorite items that have been shared with you, and organize them into
your own albums.
When you perform these operations, Ente will create a hard copy of these items,
that you fully own. This means, these copied items will count against your
storage space.
We understand there are use cases where this approach will consume extra space
(for eg. if you are organizing photos of a family member). We chose hard copies
as a first version to avoid complexities regarding the ownership of shared
items, in case the original owner were to delete it from their own library.
We plan to tackle these complexities in the future, by copying a reference to
the item that was shared, instead of the actual file, so that your storage will
only get consumed if the original owner deletes it from their library. If this
sounds useful to you, please participate in
[this discussion](https://github.com/ente-io/ente/discussions/790).
## Technical details
More details, including technical aspect about how the sharing features were
implemented, are in various blog posts announcing these features.
- [Collaborative albums](https://ente.io/blog/collaborative-albums)
- [Collect photos from people not on ente](https://ente.io/blog/collect-photos)
- [Shareable links for albums](https://ente.io/blog/shareable-links),
[and their underlying technical implementation](https://ente.io/blog/building-shareable-links).
Since then, we have also added the ability to password protect public links,
and configure a duration after which the link will automatically expire.
We are now working on the other requested features around sharing, including
comments and reactions.
## Limitations
Sharing is only available to paid customers. This limitation safeguards against
potential platform abuse.

18
docs/docs/photos/features/trash.md Normal file
View File

@ -0,0 +1,18 @@
---
title: Trash
description: Deleting items and trash
---
# Trash
Whenever you delete an item from Ente, it is moved to Trash. These items will be
automatically deleted from Trash after 30 days. You can manaully select photos
to permanently delete or completely empty the trash if you wish.
Items in trash are included in your used storage calculation.
## Recovery
If you have deleted items accidentally, you can recover them from Trash by
selecting these items, and clicking the "Restore" button on the action bar that
pops up.

24
docs/docs/photos/features/uncategorized.md Normal file
View File

@ -0,0 +1,24 @@
---
title: Uncategorized
description: Uncategorized items in Ente Photos
---
# Uncategorized
_Uncategorized_ is a special album type where photos are automatically added
under the following circumstances:
- When you remove a photo from the last album, it is relocated to
_Uncategorized_ section.
- During album deletion, if you choose to keep photos but delete the album, all
photos exclusive to the current album are moved to the _Uncategorized_
section.
Note: This does not include photos uploaded by others.
### Cleaning up Uncategorized items
In the mobile app, you can click on the overflow menu and click _Clean
Uncategorized_ option. All files that are also present in another album, that is
owned by the user, will be removed from the _Uncategorized_ section.

56
docs/docs/photos/features/watch-folders.md Normal file
View File

@ -0,0 +1,56 @@
---
title: Watch folder
description:
Automatic syncing of selected folders using the Ente Photos desktop app
---
# Watch folders
The Ente desktop app allows you to "watch" a folder on your computer for any
changes, creating a one-way background sync from folders on your computer to
Ente albums. This is intended to automate your photo management and backup.
By using the "Watch folders" option in the sidebar, you can tell the desktop app
which are the folders that you want to watch for changes. The app will then
automatically upload new files added to these folders to the corresponding ente
album (it will also upload them initially). And if a file is deleted locally,
then the corresponding Ente file will also be automatically moved to
uncategorized.
Paired with the option to run Ente automatically when your computer starts, this
allows you to automate backups to ente's cloud.
### Steps
1. Press the **Watch folders** button in the sidebar. This will open up a dialog
where you can add and remove watched folders.
2. To start watching a folder, press the **Add folder** button and select the
folder on your system that you want to watch for any changes. You can also
drag and drop the folder here.
3. If the folder has nesting, you will see two options - **A single album** and
**Separate albums**. This work similarly to the
[options you see when you drag and drop a folder with nested folders](/photos/features/albums#preserving-folder-structure).
4. After choosing any of the above options, the folder will be initially synced
to Ente's cloud and monitored for any changes. You can now close the dialog
and the sync will continue in background.
5. When the app is syncing in the background it'll show a small progress status
in the bottom right. You can expand it to see more details if needed.
6. You can stop watching any folder by clicking on the three dots next to the
watch folder entry, and then selecting **Stop watching**.
> Note: In case you start a new upload while an existing sync is in progress,
> the sync will be paused then and resumed when your upload is done.
Some more details about the feature are in our
[blog post](http://ente.io/blog/watch-folders) announcing it.
## 2-way sync
Note that a two way sync is not currently supported. Attempting to export data
to the same folder that is also being watched by the Ente app will result in
undefined behaviour (e.g. duplicate files, export stalling etc).

19
docs/docs/photos/index.md Normal file
View File

@ -0,0 +1,19 @@
---
title: Ente Photos
description: User guide for Ente Photos
---
# Ente Photos
Ente Photos is an end-to-end encrypted alternative to Google Photos and Apple
Photos. You can use it to safely and securely store your photos on the cloud.
While security and privacy form the bedrock of Ente Photos, it is not at the
cost of usability. The user interface is simple, and we are continuously working
to make it even simpler.
The goal is a product that can be used by people with all sorts of technical
ability and background.
These help docs are divided into four sections. Choose the relevant page from
the sidebar menu, or use the search at the top.

BIN
docs/docs/photos/migration/export/continuous-sync.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
docs/docs/photos/migration/export/export-1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.7 MiB

BIN
docs/docs/photos/migration/export/export-2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
docs/docs/photos/migration/export/export-3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
docs/docs/photos/migration/export/export-4.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/docs/photos/migration/export/export-5.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

70
docs/docs/photos/migration/export/index.md Normal file
View File

@ -0,0 +1,70 @@
---
title: Exporting your data from Ente Photos
description: Guide for exporting your photos out from Ente Photos
---
# Exporting your data out of Ente Photos
Please follow the following simple steps to keep a local copy of the photos and
videos you have uploaded to Ente.
1. Sign in to [our desktop app](https://ente.io/download/desktop), if you
haven't done so already.
![Ente - Sign in to export data](sign-in.png)
2. Open the side bar, and select the option to **Export Data**.
![Ente - Export data](export-1.png)
3. Choose the destination folder by clicking on three dots icon.
<div align="center">
![Ente - Select destination folder and start](export-2.png){width=400px}
</div>
4. Select the folder and then click on **Start**
<div align="center">
![Ente - Export in progress](export-3.png){width=400px}
</div>
5. Wait for the export to complete.
<div align="center">
![Ente - Rexport](export-4.png){width=400px}
</div>
6. In case your download gets interrupted, Ente will resume from where it left
off. Simply select **Export Data** again and click on **Resync**.
<div align="center">
![Ente - Rexport](export-5.png){width=400px}
</div>
### Sync continuously
You can switch on the toggle to **Sync continuously** to eliminate manual
exports each time new photos are added to Ente. This feature automatically
detects new files and runs exports accordingly. It also ensures that exported
data reflects the latest album states with new files, moves, and deletions.
![Ente - Continuous sync](continuous-sync.webp)
---
If you run into any issues during your data export, please reach out to
[support@ente.io](mailto:support@ente.io) and we will be happy to help you!
Note that we also provide a
[CLI tool](https://github.com/ente-io/ente/tree/main/cli#export) to export your
data. You can find more information about the export in the
[export FAQ](/photos/faq/export).

BIN
docs/docs/photos/migration/export/sign-in.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 161 KiB

24
docs/docs/photos/migration/from-amazon-photos.md Normal file
View File

@ -0,0 +1,24 @@
---
title: Import from Amazon Photos
description: Migrating your existing photos from Amazon Photos to Ente Photos
---
# Import from Amazon Photos
Amazon Photos does not provide a way to export all of your photos and videos, or
even albums with a single click.
According to their
[help desk article](https://www.amazon.com/gp/help/customer/display.html?nodeId=GVCELKY5JW77VE7W),
you have to select and download photos individually.
Once you've done that, simply drag and drop this folder into
[our desktop app](https://ente.io/download/desktop), and Ente will take care of
the rest.
> Note: In case your uploads get interrupted, just drag and drop the folder into
> the same album again, and we will ignore already backed up files and upload
> just the rest.
If you run into any issues during this migration, please reach out to
[support@ente.io](mailto:support@ente.io) and we will be happy to help you!

BIN
docs/docs/photos/migration/from-apple-photos/export.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 122 KiB

54
docs/docs/photos/migration/from-apple-photos/index.md Normal file
View File

@ -0,0 +1,54 @@
---
title: Import from Apple Photos
description: Migrating your existing photos from Apple Photos to Ente Photos
---
# Import from Apple Photos
## Mobile
If you are using Apple Photos on your phone, then the most seamless way is to
install the Ente app on your mobile device. The Ente app will directly read from
your iCloud library and import.
> [!TIP]
>
> For large libraries, this process may take a bit of time, so you can speed it
> up by keeping the app running in the foreground while the initial import is in
> progress (Note: this is only needed during the initial import, subsequently
> the app will automatically backup photos in the background as you take them).
## Desktop
Alternatively, or if you prefer to use the desktop app, then you can use the
following steps:
#### 1. Export your data from the Apple Photos app.
Select the files you want to export (`Command + A` to select them all), and
click on `File` > `Export` > `Export Unmodified Originals`.
![Apple Photos - Export](export.png)
In the dialog that pops up, select File Name as `Sequential` and provide any
prefix you'd like. This is to make sure that we combine the photo and video
portions of your Live Photos correctly.
![Apple Photos - Sequential file names](sequential.png)
Finally, choose an export directory and confirm by clicking `Export Originals`.
You will receive a notification from the app once your export is complete.
#### 2. Import into Ente
Now simply drag and drop the downloaded folders into
[our desktop app](https://ente.io/download/desktop) and grab a cup of coffee (or
a good night's sleep, depending on the size of your library) while we handle the
rest.
> Note: In case your uploads get interrupted, just drag and drop the folders
> into the same albums again, and we will ignore already backed up files and
> upload just the rest.
If you run into any issues during this migration, please reach out to
[support@ente.io](mailto:support@ente.io) and we will be happy to help you!

BIN
docs/docs/photos/migration/from-apple-photos/sequential.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/docs/photos/migration/from-google-photos/google-photos-1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/docs/photos/migration/from-google-photos/google-photos-2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/docs/photos/migration/from-google-photos/google-photos-3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/docs/photos/migration/from-google-photos/google-photos-4.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

BIN
docs/docs/photos/migration/from-google-photos/google-photos-5.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
docs/docs/photos/migration/from-google-photos/google-takeout.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

78
docs/docs/photos/migration/from-google-photos/index.md Normal file
View File

@ -0,0 +1,78 @@
---
title: Import from Google Photos
description: Migrating your existing photos from Google Photos to Ente Photos
---
# Import from Google Photos
Follow the following steps to recover your data from Google Photos and preserve
it with Ente.
### Steps
1. Open [takeout.google.com](https://takeout.google.com).
2. Click on "Deselect All" (since by default all Google services are selected).
![Google Takeout - Create a new export](google-photos-1.png)
3. Scroll down to find Google Photos in the list and select it by clicking the
check box next to it.
![Google Takeout - Select Google Photos](google-photos-2.png)
4. Click on the button that says "All photo albums included".
5. Select the albums you want to export.
![Google Takeout - Select albums](google-photos-3.png)
6. Scroll down and click on "Next Step".
![Google Takeout - Next](google-photos-4.png)
7. Select "Frequency" and "File size" depending on the amount of storage on your
system and click on "Create export". Make sure you select ZIP as the format.
![Google Takeout - Frequency and file size](google-photos-5.png)
8. Wait for Google to send you your data.
9. Open [our desktop app](https://ente.io/download/desktop), click on "Upload",
select "Google takeout" and pick the ZIP file you just downloaded. If you
were provided with multiple ZIP files, please extract **all** the ZIP files
into one folder and select that folder instead.
> While the app supports uploading multiple ZIPs too, we recommend unzipping
> them all into a single folder and uploading that folder instead so that your
> photo dates are imported properly
> ([details](/photos/faq/metadata#importing-from-google-takeout)).
>
> <br />
>
> Note that you can still preserve your albums even when uploading a single
> folder - select the create new album option and the app will ask you if you
> want to put each leaf folder into a separate album
> ([details](/photos/features/albums#uploading-a-nested-folder)).
![Importing Google Takeout into Ente](google-takeout.png){width=400px}
10. Wait for the uploads to complete as Ente parses the metadata generated by
Google, and preserves them along with the corresponding files, end-to-end
encrypted!
---
In case your uploads get interrupted, just drag and drop the file again and we
will ignore already backed up files and upload just the rest.
If you run into any issues during this migration, please reach out to
[support@ente.io](mailto:support@ente.io) and we will be happy to help you!
> [!TIP]
>
> In case you wish to use face recognition and other advanced search features
> provided by Ente, we recommend that you enable
> [machine learning](/photos/features/machine-learning) before importing your
> photos so that the Ente app can directly index files as they are getting
> uploaded.

19
docs/docs/photos/migration/from-local-hard-disk.md Normal file
View File

@ -0,0 +1,19 @@
---
title: Import from local hard disk
description:
Migrating to Ente Photos by importing data from your local hard disk
---
# Import photos from your local hard disk
Simply drag and drop the folders you want to preserve into
[our desktop app](https://ente.io/download/desktop) and grab a cup of coffee (or
a good night's sleep depending on the size of your library), while we will take
care of the rest.
> Note: in case your uploads get interrupted, just drag and drop the folders
> into the same albums again, and we will ignore already backed up files and
> upload just the rest.
If you run into any issues during uploads, please reach out to
[support@ente.io](mailto:support@ente.io) and we will be happy to help you!

14
docs/docs/photos/migration/index.md Normal file
View File

@ -0,0 +1,14 @@
---
title: Migrating
description:
Guides for migrating your existing photos into Ente Photos and exporting
your data out of Ente Photos
---
# Migrating to/from Ente Photos
- [Import from Google Photos](from-google-photos/)
- [Import from Apple Photos](from-apple-photos/)
- [Import from Amazon Photos](from-amazon-photos)
- [Import from local hard disk](from-local-hard-disk)
- [Export out of Ente Photos](export/)

101
docs/docs/photos/troubleshooting/desktop-install/index.md Normal file
View File

@ -0,0 +1,101 @@
---
title: Desktop installation
description: Troubleshooting issues when installing the Ente Photos desktop app
---
# Desktop app installation
The latest version of the Ente Photos desktop app can be downloaded from
[ente.io/download](https://ente.io/download). If you're having trouble, please
see if any of the following cases apply.
- [Windows](#windows)
- [Linux](#linux)
## Windows
If the app stops with an "A JavaScript error occurred in the main process - The
specified module could not be found" error on your Windows machine when you
start it, then you might need to install the VC++ runtime from Microsoft.
This is what the error looks like:
<div style="border: 1px solid black">
![Error when VC++ runtime is not installed](windows-vc.png){width=500px}
</div>
You can install the Microsoft VC++ redistributable runtime from here:<br/>
https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-microsoft-visual-c-redistributable-version
## Linux
### AppImage desktop integration
AppImages are not fully standalone, and they require additional steps to enable
full "desktop integration":
- Showing the app icon,
- Surfacing the app in the list of installed apps,
- Handling redirection after passkey verification.
All the ways of enabling AppImage desktop integration are mentioned in
[AppImage documentation](https://docs.appimage.org/user-guide/run-appimages.html#integrating-appimages-into-the-desktop).
For example, you can download the
[appimaged](https://github.com/probonopd/go-appimage/releases) AppImage, run it,
and then download the Ente Photos AppImage into your `~/Downloads` folder.
_appimaged_ will then pick it up automatically.
### AppImages on ARM64
If you're on an ARM64 machine running Linux, and the AppImages doesn't do
anything when you run it, you will need to run the following command on your
machine:
```sh
sudo ln -s /usr/lib/aarch64-linux-gnu/libz.so{.1,}
```
It is possible that the exact path might be different on your machine. Briefly,
what we need to do is create `libz.so` as an alias for `libz.so.1`. For more
details, see the following upstream issues:
- libz.so cannot open shared object file on ARM64 -
[AppImage/AppImageKit/issues/1092](https://github.com/AppImage/AppImageKit/issues/1092)
- libz.so: cannot open shared object file with Ubuntu arm64 -
[electron-userland/electron-builder/issues/7835](https://github.com/electron-userland/electron-builder/issues/7835)
### AppImage says it requires FUSE
See
[docs.appimage.org](https://docs.appimage.org/user-guide/troubleshooting/fuse.html#the-appimage-tells-me-it-needs-fuse-to-run).
tl;dr; for example, on Ubuntu,
```sh
sudo apt install libfuse2
```
### Linux SUID error
On some Linux distributions, if you run the AppImage from the CLI, it might fail
with the following error:
> The SUID sandbox helper binary was found, but is not configured correctly.
This happens when you try to run the AppImage from the command line. If you
instead double click on the AppImage in your Files browser, then it should start
properly.
If you do want to run it from the command line, you can do so by passing the
`--no-sandbox` flag when executing the AppImage. e.g.
```sh
./ente.AppImage --no-sandbox
```
For more details, see this upstream issue on
[electron](https://github.com/electron/electron/issues/17972).

BIN
docs/docs/photos/troubleshooting/desktop-install/windows-vc.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

28
docs/docs/photos/troubleshooting/files-not-uploading.md Normal file
View File

@ -0,0 +1,28 @@
---
title: Files not uploading
description:
Troubleshooting when files are not uploading from your Ente Photos app
---
# Files not uploading
## Network Issue
If you are using VPN, please try disabling the VPN or switching your provider.
## Web / Desktop
### Disable "Faster uploads"
We use a Cloudflare proxy to speed up uploads
([blog post](https://ente.io/blog/tech/making-uploads-faster/)). However, in
some network configurations (depending on the ISP) this might prevent uploads
from going through, so if you're having trouble with uploads please try after
disabling the "Faster uploads" setting in _Preferences > Advanced_.
### Certain file types are not uploading
The desktop/web app tries to detect if a particular file is video or image. If
the detection fails, then the app skips the upload. Please contact our
[support](mailto:support@ente.io) if you find that a valid file did not get
detected and uploaded.

Some files were not shown because too many files have changed in this diff Show More