Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2025-11-04 03:27:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore(doc): update quick-start.mdx (#10276)

Browse Source 
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.
This commit is contained in:
Richard Salame 2024-06-13 19:53:02 +05:30 committed by GitHub
parent e2a2c86a31
commit 827ec1b63a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/overview/quick-start.mdx
View File

@ -5,21 +5,21 @@ sidebar_position: 3
# Quick Start # Quick Start
Here is a quick, no-choices path to install Immich and take it for a test drive. Here is a quick, no-choices path to install Immich and take it for a test drive.
Once you've tried it, perhaps you'll use one of the many other ways Once you've tried it, you might use one of the many other ways
to install and use it. to install and use it.
## Requirements ## Requirements
Check the [requirements page](/docs/install/requirements) to get started. Check the [requirements page](/docs/install/requirements) to get started.
## Install and launch via Docker Compose ## Install and Launch via Docker Compose
Follow the [Docker Compose (Recommended)](/docs/install/docker-compose) instructions Follow the [Docker Compose (Recommended)](/docs/install/docker-compose) instructions
to install the server. to install the server.
- Where random passwords are required, `pwgen` is a handy utility. - Where random passwords are required, `pwgen` is a handy utility.
- `UPLOAD_LOCATION` should be set to some new directory on the server - `UPLOAD_LOCATION` should be set to some new directory on the server
with free space. with enough free space.
- You may ignore "Step 4 - Upgrading". - You may ignore "Step 4 - Upgrading".
## Try the Web UI ## Try the Web UI
@ -48,26 +48,26 @@ import MobileAppLogin from '/docs/partials/_mobile-app-login.md';
In the mobile app, you should see the photo you uploaded from the web UI. In the mobile app, you should see the photo you uploaded from the web UI.
### Transfer Photos from your Mobile Device ### Transfer Photos from Your Mobile Device
import MobileAppBackup from '/docs/partials/_mobile-app-backup.md'; import MobileAppBackup from '/docs/partials/_mobile-app-backup.md';
<MobileAppBackup /> <MobileAppBackup />
Depending on how many photos are on your mobile device, this backup may The backup time differs depending on how many photos are on your mobile device. Large uploads may
take quite a while. take quite a while.
You can select the Jobs tab to see Immich processing your photos. 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" /> <img src={require('/docs/guides/img/jobs-tab.png').default} title="Jobs tab" />
## Set up your backups ## Set up Your Backups
You may want to back up the content of your Immich instance You may want to back up the content of your Immich instance
along with other parts of your server; be sure to read about along with other parts of your server; be sure to read about
[database backup](/docs/administration/backup-and-restore). [database backup](/docs/administration/backup-and-restore).
## Where to go from here? ## Where to Go From Here
You may decide you'd like to install the server a different way; You may decide you'd like to install the server a different way;
the Install category on the left menu provides many options. the Install category on the left menu provides many options.