mirror of
https://github.com/immich-app/immich
synced 2025-11-07 17:27:20 +00:00
chore(docs): refactor pages (#1144)
* chore(docs): refactor pages * fix: links * fix: broken link * refactor: post install steps using partials
This commit is contained in:
parent
7966c925ea
commit
752b267399
67 changed files with 380 additions and 258 deletions
9
docs/docs/partials/_mobile-app-backup.md
Normal file
9
docs/docs/partials/_mobile-app-backup.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.
|
||||
|
||||
<img src={require('./img/backup-header.png').default} width='50%' title='Backup button' />
|
||||
|
||||
You can select which album(s) you want to back up to the Immich server from the backup screen.
|
||||
|
||||
<img src={require('./img/album-selection.png').default} width='50%' title='Backup button' />
|
||||
|
||||
Scroll down to the bottom and press "**Start Backup**" to start the backup process.
|
||||
6
docs/docs/partials/_mobile-app-download.md
Normal file
6
docs/docs/partials/_mobile-app-download.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
The mobile app can be downloaded from the following places:
|
||||
|
||||
- [Google Play Store](https://play.google.com/store/apps/details?id=app.alextran.immich)
|
||||
- [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
|
||||
- [F-Droid](https://f-droid.org/packages/app.alextran.immich)
|
||||
- [Github Releases (apk)](https://github.com/immich-app/immich/releases)
|
||||
3
docs/docs/partials/_mobile-app-login.md
Normal file
3
docs/docs/partials/_mobile-app-login.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
Login to the mobile app with the server endpoint URL at `http://<machine-ip-address>:2283/api`
|
||||
|
||||
<img src={require('./img/sign-in-phone.jpeg').default} width='50%' title='Mobile App Sign In' />
|
||||
7
docs/docs/partials/_register-admin.md
Normal file
7
docs/docs/partials/_register-admin.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
The first user to register will be the admin user. The admin user will be able to add other users to the application.
|
||||
|
||||
To register for the admin user, access the web application at `http://<machine-ip-address>:2283` and click on the **Getting Started** button.
|
||||
|
||||
<img src={require('./img/admin-registration-form.png').default} width="500" title="Admin Registration" />
|
||||
|
||||
Follow the prompts to register as the admin user and log in to the application.
|
||||
11
docs/docs/partials/_storage-template.md
Normal file
11
docs/docs/partials/_storage-template.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
Immich allows the admin user to set the pattern of how the files are uploaded to the Immich would look like. Both in the directory and the filename level.
|
||||
|
||||
The admin user can set the template by using the template builder in the `Administration -> Settings -> Storage Template`. Immich provides a set of variables that you can use in constructing the template, along with additional custom text.
|
||||
|
||||
```bash title="Default template"
|
||||
Year/Year-Month-Day/Filename.Extension
|
||||
```
|
||||
|
||||
<img src={require('./img/storage-template.png').default} width="100%" title="Storage Template Setting" />
|
||||
|
||||
Immich also provides a mechanism to migrate between template so that if the template you set now doesn't work in the future, you can always migrate all the existing files to the new template. The mechanism is run as a job in the Job page.
|
||||
3
docs/docs/partials/_user-create.md
Normal file
3
docs/docs/partials/_user-create.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
If you have friends or family members who want to use the application as well, you can create addition accounts. The default password is `password`, and the user can change their password after logging in to the application for the first time.
|
||||
|
||||
<img src={require('./img/create-new-user.png').default} title='Admin Registration' />
|
||||
BIN
docs/docs/partials/img/admin-registration-form.png
Normal file
BIN
docs/docs/partials/img/admin-registration-form.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 105 KiB |
BIN
docs/docs/partials/img/album-selection.png
Normal file
BIN
docs/docs/partials/img/album-selection.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 160 KiB |
BIN
docs/docs/partials/img/backup-header.png
Normal file
BIN
docs/docs/partials/img/backup-header.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
docs/docs/partials/img/create-new-user.png
Normal file
BIN
docs/docs/partials/img/create-new-user.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
BIN
docs/docs/partials/img/sign-in-phone.jpeg
Normal file
BIN
docs/docs/partials/img/sign-in-phone.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 321 KiB |
BIN
docs/docs/partials/img/storage-template.png
Normal file
BIN
docs/docs/partials/img/storage-template.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 335 KiB |
Loading…
Add table
Add a link
Reference in a new issue