827ec1b63a
Update quick-start.mdx The following changes are made: - Changed the headings to capital case. - Changed a few sentences to sound more clear. - Removed '?' from the heading as per the standards.
88 lines
2.5 KiB
Plaintext
88 lines
2.5 KiB
Plaintext
---
|
|
sidebar_position: 3
|
|
---
|
|
|
|
# Quick Start
|
|
|
|
Here is a quick, no-choices path to install Immich and take it for a test drive.
|
|
Once you've tried it, you might use one of the many other ways
|
|
to install and use it.
|
|
|
|
## Requirements
|
|
|
|
Check the [requirements page](/docs/install/requirements) to get started.
|
|
|
|
## Install and Launch via Docker Compose
|
|
|
|
Follow the [Docker Compose (Recommended)](/docs/install/docker-compose) instructions
|
|
to install the server.
|
|
|
|
- Where random passwords are required, `pwgen` is a handy utility.
|
|
- `UPLOAD_LOCATION` should be set to some new directory on the server
|
|
with enough free space.
|
|
- You may ignore "Step 4 - Upgrading".
|
|
|
|
## Try the Web UI
|
|
|
|
import RegisterAdminUser from '/docs/partials/_register-admin.md';
|
|
|
|
<RegisterAdminUser />
|
|
|
|
Try uploading a picture from your browser.
|
|
|
|
<img src={require('./img/upload-button.png').default} title="Upload button" />
|
|
|
|
## Try the Mobile UI
|
|
|
|
### Download the Mobile App
|
|
|
|
import MobileAppDownload from '/docs/partials/_mobile-app-download.md';
|
|
|
|
<MobileAppDownload />
|
|
|
|
### Login to the Mobile App
|
|
|
|
import MobileAppLogin from '/docs/partials/_mobile-app-login.md';
|
|
|
|
<MobileAppLogin />
|
|
|
|
In the mobile app, you should see the photo you uploaded from the web UI.
|
|
|
|
### Transfer Photos from Your Mobile Device
|
|
|
|
import MobileAppBackup from '/docs/partials/_mobile-app-backup.md';
|
|
|
|
<MobileAppBackup />
|
|
|
|
The backup time differs depending on how many photos are on your mobile device. Large uploads may
|
|
take quite a while.
|
|
|
|
You can select the **Jobs** tab to see Immich processing your photos.
|
|
|
|
<img src={require('/docs/guides/img/jobs-tab.png').default} title="Jobs tab" />
|
|
|
|
## Set up Your Backups
|
|
|
|
You may want to back up the content of your Immich instance
|
|
along with other parts of your server; be sure to read about
|
|
[database backup](/docs/administration/backup-and-restore).
|
|
|
|
## Where to Go From Here
|
|
|
|
You may decide you'd like to install the server a different way;
|
|
the Install category on the left menu provides many options.
|
|
|
|
You may decide you'd like to add the _rest_ of your photos from Google Photos,
|
|
even those not on your mobile device, via Google Takeout.
|
|
You can use [immich-go](https://github.com/simulot/immich-go) for this.
|
|
|
|
You may want to
|
|
[upload photos from your own archive](/docs/features/command-line-interface).
|
|
|
|
You may want to incorporate an immutable archive of photos from an
|
|
[External Library](/docs/features/libraries#external-libraries);
|
|
there's a [Guide](/docs/guides/external-library) for that.
|
|
|
|
You may want your mobile device to
|
|
[back photos up to your server automatically](/docs/features/automatic-backup).
|