Skip to content

Commit

Permalink
Update readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@alextran1502
alextran1502 committed Dec 19, 2022
1 parent b88e246 commit 42e5754
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 18 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
| Virtual scroll | Yes | Yes |
| OAuth Support | Yes | Yes |
| LivePhotos Backup and Playback (iOS only) | Yes | Yes |
| User-defined storage structure | Yes | Yes |

# Support the project

Expand Down
Binary file added docs/docs/usage/img/storage-template.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 18 additions & 4 deletions docs/docs/usage/post-installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,21 @@ The mobile app can be downloaded from
- [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
- [F-Droid](https://f-droid.org/packages/app.alextran.immich)

## Step 2 - Register the admin user
## Step 2 - Set storage template

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 construting 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.

## Step 3 - Register the admin user

The first user to register will be the admin user. The admin user will be able to add other users to the application.

Expand All @@ -24,19 +38,19 @@ To register for the admin user, access the web application at `http://<machine-i

Follow the prompts to register as the admin user and log in to the application.

## Step 3 - Create a new user (optional)
## Step 4 - Create a new user (optional)

If you have a family member who wants to use the application, you can create a new account. 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" />

## Step 4 - Access the mobile app
## Step 5 - Access the mobile app

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" />

## Step 5 - Back up your photos and videos
## Step 6 - Back up your photos and videos

Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.

Expand Down
1 change: 1 addition & 0 deletions mobile/android/fastlane/metadata/android/en-US/changelogs/62.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Add additional supported translation for CZ, SK, and CN
6 changes: 3 additions & 3 deletions mobile/android/fastlane/report.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@



<testcase classname="fastlane.lanes" name="0: default_platform" time="0.000201">
<testcase classname="fastlane.lanes" name="0: default_platform" time="0.000213">

</testcase>


<testcase classname="fastlane.lanes" name="1: bundleRelease" time="63.132489">
<testcase classname="fastlane.lanes" name="1: bundleRelease" time="61.218233">

</testcase>


<testcase classname="fastlane.lanes" name="2: upload_to_play_store" time="38.15883">
<testcase classname="fastlane.lanes" name="2: upload_to_play_store" time="41.974053">

</testcase>

Expand Down
6 changes: 3 additions & 3 deletions mobile/ios/Runner.xcodeproj/project.pbxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@
CODE_SIGN_ENTITLEMENTS = Runner/RunnerProfile.entitlements;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 74;
CURRENT_PROJECT_VERSION = 76;
DEVELOPMENT_TEAM = 2F67MQ8R79;
ENABLE_BITCODE = NO;
INFOPLIST_FILE = Runner/Info.plist;
Expand Down Expand Up @@ -495,7 +495,7 @@
CLANG_ENABLE_MODULES = YES;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 74;
CURRENT_PROJECT_VERSION = 76;
DEVELOPMENT_TEAM = 2F67MQ8R79;
ENABLE_BITCODE = NO;
INFOPLIST_FILE = Runner/Info.plist;
Expand All @@ -522,7 +522,7 @@
CLANG_ENABLE_MODULES = YES;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 74;
CURRENT_PROJECT_VERSION = 76;
DEVELOPMENT_TEAM = 2F67MQ8R79;
ENABLE_BITCODE = NO;
INFOPLIST_FILE = Runner/Info.plist;
Expand Down
4 changes: 2 additions & 2 deletions mobile/ios/Runner/Info.plist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>1.37.1</string>
<string>1.39.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>74</string>
<string>76</string>
<key>LSRequiresIPhoneOS</key>
<true />
<key>MGLMapboxMetricsEnabledSettingShownInApp</key>
Expand Down
15 changes: 9 additions & 6 deletions mobile/ios/fastlane/report.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,32 @@



<testcase classname="fastlane.lanes" name="0: default_platform" time="0.000334">
<testcase classname="fastlane.lanes" name="0: default_platform" time="0.000212">

</testcase>


<testcase classname="fastlane.lanes" name="1: increment_version_number" time="1.671363">
<testcase classname="fastlane.lanes" name="1: increment_version_number" time="1.00785">

</testcase>


<testcase classname="fastlane.lanes" name="2: latest_testflight_build_number" time="7.167423">
<testcase classname="fastlane.lanes" name="2: latest_testflight_build_number" time="5.724004">

</testcase>


<testcase classname="fastlane.lanes" name="3: increment_build_number" time="0.654653">
<testcase classname="fastlane.lanes" name="3: increment_build_number" time="0.670744">

</testcase>


<testcase classname="fastlane.lanes" name="4: build_app" time="29.319346">
<testcase classname="fastlane.lanes" name="4: build_app" time="85.266784">

<failure message="/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/actions/actions_helper.rb:67:in `execute_action&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:255:in `block in execute_action&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:229:in `chdir&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:229:in `execute_action&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:157:in `trigger_action_by_name&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/fast_file.rb:159:in `method_missing&apos;&#10;Fastfile:27:in `block (2 levels) in parsing_binding&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/lane.rb:33:in `call&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:49:in `block in execute&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:45:in `chdir&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/runner.rb:45:in `execute&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/lane_manager.rb:47:in `cruise_lane&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/command_line_handler.rb:36:in `handle&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/commands_generator.rb:110:in `block (2 levels) in run&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/commander-4.6.0/lib/commander/command.rb:187:in `call&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/commander-4.6.0/lib/commander/command.rb:157:in `run&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/commander-4.6.0/lib/commander/runner.rb:444:in `run_active_command&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane_core/lib/fastlane_core/ui/fastlane_runner.rb:124:in `run!&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/commander-4.6.0/lib/commander/delegates.rb:18:in `run!&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/commands_generator.rb:354:in `run&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/commands_generator.rb:43:in `start&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/fastlane/lib/fastlane/cli_tools_distributor.rb:123:in `take_off&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/gems/fastlane-2.210.1/bin/fastlane:23:in `&lt;top (required)&gt;&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/bin/fastlane:25:in `load&apos;&#10;/usr/local/Cellar/fastlane/2.210.1/libexec/bin/fastlane:25:in `&lt;main&gt;&apos;&#10;&#10;Error building the application - see the log above" />
</testcase>


<testcase classname="fastlane.lanes" name="5: upload_to_testflight" time="59.733923">

</testcase>

Expand Down

1 comment on commit 42e5754

@vercel
Copy link

@vercel vercel bot commented on 42e5754 Dec 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

immich – ./

immich.vercel.app
www.immich.app
immich-immich.vercel.app
docs.immich.app
immich.app
immich-git-main-immich.vercel.app
documentation.immich.app

Please sign in to comment.