Browse Source

Update readme and docs

Alex 2 years ago
parent
commit
42e57547f7

+ 1 - 0
README.md

@@ -78,6 +78,7 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 | Virtual scroll                              | Yes     | Yes |
 | Virtual scroll                              | Yes     | Yes |
 | OAuth Support                               | Yes     | Yes |
 | OAuth Support                               | Yes     | Yes |
 | LivePhotos Backup and Playback (iOS only)   | Yes     | Yes |
 | LivePhotos Backup and Playback (iOS only)   | Yes     | Yes |
+| User-defined storage structure              | Yes     | Yes |
 
 
 # Support the project
 # Support the project
 
 

BIN
docs/docs/usage/img/storage-template.png


+ 18 - 4
docs/docs/usage/post-installation.md

@@ -14,7 +14,21 @@ The mobile app can be downloaded from
 - [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
 - [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
 - [F-Droid](https://f-droid.org/packages/app.alextran.immich)
 - [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.
 The first user to register will be the admin user. The admin user will be able to add other users to the application.
 
 
@@ -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.
 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.
 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" />
 <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`
 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" />
 <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.
 Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.
 
 

+ 1 - 0
mobile/android/fastlane/metadata/android/en-US/changelogs/62.txt

@@ -0,0 +1 @@
+* Add additional supported translation for CZ, SK, and CN

+ 3 - 3
mobile/android/fastlane/report.xml

@@ -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>
     
     
       
       
-      <testcase classname="fastlane.lanes" name="1: bundleRelease" time="63.132489">
+      <testcase classname="fastlane.lanes" name="1: bundleRelease" time="61.218233">
         
         
       </testcase>
       </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>
       </testcase>
     
     

+ 3 - 3
mobile/ios/Runner.xcodeproj/project.pbxproj

@@ -360,7 +360,7 @@
 				CODE_SIGN_ENTITLEMENTS = Runner/RunnerProfile.entitlements;
 				CODE_SIGN_ENTITLEMENTS = Runner/RunnerProfile.entitlements;
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_STYLE = Automatic;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 74;
+				CURRENT_PROJECT_VERSION = 76;
 				DEVELOPMENT_TEAM = 2F67MQ8R79;
 				DEVELOPMENT_TEAM = 2F67MQ8R79;
 				ENABLE_BITCODE = NO;
 				ENABLE_BITCODE = NO;
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_FILE = Runner/Info.plist;
@@ -495,7 +495,7 @@
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_STYLE = Automatic;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 74;
+				CURRENT_PROJECT_VERSION = 76;
 				DEVELOPMENT_TEAM = 2F67MQ8R79;
 				DEVELOPMENT_TEAM = 2F67MQ8R79;
 				ENABLE_BITCODE = NO;
 				ENABLE_BITCODE = NO;
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_FILE = Runner/Info.plist;
@@ -522,7 +522,7 @@
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_STYLE = Automatic;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 74;
+				CURRENT_PROJECT_VERSION = 76;
 				DEVELOPMENT_TEAM = 2F67MQ8R79;
 				DEVELOPMENT_TEAM = 2F67MQ8R79;
 				ENABLE_BITCODE = NO;
 				ENABLE_BITCODE = NO;
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_FILE = Runner/Info.plist;

+ 2 - 2
mobile/ios/Runner/Info.plist

@@ -17,11 +17,11 @@
     <key>CFBundlePackageType</key>
     <key>CFBundlePackageType</key>
     <string>APPL</string>
     <string>APPL</string>
     <key>CFBundleShortVersionString</key>
     <key>CFBundleShortVersionString</key>
-    <string>1.37.1</string>
+    <string>1.39.0</string>
     <key>CFBundleSignature</key>
     <key>CFBundleSignature</key>
     <string>????</string>
     <string>????</string>
     <key>CFBundleVersion</key>
     <key>CFBundleVersion</key>
-    <string>74</string>
+    <string>76</string>
     <key>LSRequiresIPhoneOS</key>
     <key>LSRequiresIPhoneOS</key>
     <true />
     <true />
     <key>MGLMapboxMetricsEnabledSettingShownInApp</key>
     <key>MGLMapboxMetricsEnabledSettingShownInApp</key>

File diff suppressed because it is too large
+ 5 - 5
mobile/ios/fastlane/report.xml


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