Auto-update README

README.md

@@ -19,12 +19,9 @@ Package to create a Time Machine Backup Source
 
 ### Features
 
-- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
+- Automatically detected by Time Machine
-- Laboris nisi ut aliquip ex ea commodo consequat ;
+- Integrated with YunoHost's Backups
-- Duis aute irure dolor in reprehenderit in voluptate ;
+- Supports multiple installs
-- Velit esse cillum dolore eu fugiat nulla pariatur ;
-- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
-
 
 **Shipped version:** 1.0~ynh3
 
@@ -37,24 +34,22 @@ Package to create a Time Machine Backup Source
 ## Disclaimers / important information
 
 * Any known limitations, constrains or stuff not working, such as (but not limited to):
-    * requiring a full dedicated domain ?
+    * Only the *.local location is detected automatically. To use the domain, you need to first manually connect to the server using the command `open THE_CONNECTION_STRING` on your Mac
-    * architectures not supported ?
+    * There is currently no granular control for disallowing connections from hosts (i.e anyone with the username, password and domain can connect to the Time Machine Volume)
-    * not-working single-sign on or LDAP integration ?
-    * the app requires an important amount of RAM / disk / .. to install or to work properly
-    * etc...
 
-* Other infos that people should be aware of, such as:
+* Connecting manually:
-    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
+    * The connection string format is also sent via e-mail `smb://timemachine:password@IP_OR_DOMAIN/timemachine`
-    * how to configure / administrate the application if it ain't obvious
+    * In Finder, use `Command+K` and enter the connection string. If `timemachine` is greyed out, you might need to unmount the volume using the command `sudo umount /Volumes/timemachine` first
-    * upgrade process / specificities / things to be aware of ?
+
-    * security considerations ?
+* Disallowing connections from outside network:
+    * Edit either `/etc/samba/smb.conf` or `/etc/smb/smb.d/timemachine.conf` (An option might be added in the future)
 
 ## Documentation and resources
 
-* Official app website: <https://example.com>
+* Official app website: <https://support.apple.com/en-us/HT201250>
-* Official user documentation: <https://yunohost.org/apps>
+* Official user documentation: <https://support.apple.com/en-us/HT201250>
 * Official admin documentation: <https://yunohost.org/packaging_apps>
-* Upstream app code repository: <https://some.forge.com/example/example>
+* Upstream app code repository: <https://github.com/YunoHost-Apps/timemachine_ynh>
 * YunoHost documentation for this app: <https://yunohost.org/app_timemachine>
 * Report a bug: <https://github.com/YunoHost-Apps/timemachine_ynh/issues>
 

README_fr.md

@@ -19,12 +19,9 @@ Package to create a Time Machine Backup Source
 
 ### Features
 
-- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
+- Automatically detected by Time Machine
-- Laboris nisi ut aliquip ex ea commodo consequat ;
+- Integrated with YunoHost's Backups
-- Duis aute irure dolor in reprehenderit in voluptate ;
+- Supports multiple installs
-- Velit esse cillum dolore eu fugiat nulla pariatur ;
-- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
-
 
 **Version incluse :** 1.0~ynh3
 
@@ -37,24 +34,22 @@ Package to create a Time Machine Backup Source
 ## Avertissements / informations importantes
 
 * Any known limitations, constrains or stuff not working, such as (but not limited to):
-    * requiring a full dedicated domain ?
+    * Only the *.local location is detected automatically. To use the domain, you need to first manually connect to the server using the command `open THE_CONNECTION_STRING` on your Mac
-    * architectures not supported ?
+    * There is currently no granular control for disallowing connections from hosts (i.e anyone with the username, password and domain can connect to the Time Machine Volume)
-    * not-working single-sign on or LDAP integration ?
-    * the app requires an important amount of RAM / disk / .. to install or to work properly
-    * etc...
 
-* Other infos that people should be aware of, such as:
+* Connecting manually:
-    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
+    * The connection string format is also sent via e-mail `smb://timemachine:password@IP_OR_DOMAIN/timemachine`
-    * how to configure / administrate the application if it ain't obvious
+    * In Finder, use `Command+K` and enter the connection string. If `timemachine` is greyed out, you might need to unmount the volume using the command `sudo umount /Volumes/timemachine` first
-    * upgrade process / specificities / things to be aware of ?
+
-    * security considerations ?
+* Disallowing connections from outside network:
+    * Edit either `/etc/samba/smb.conf` or `/etc/smb/smb.d/timemachine.conf` (An option might be added in the future)
 
 ## Documentations et ressources
 
-* Site officiel de l'app : <https://example.com>
+* Site officiel de l'app : <https://support.apple.com/en-us/HT201250>
-* Documentation officielle utilisateur : <https://yunohost.org/apps>
+* Documentation officielle utilisateur : <https://support.apple.com/en-us/HT201250>
 * Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
-* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
+* Dépôt de code officiel de l'app : <https://github.com/YunoHost-Apps/timemachine_ynh>
 * Documentation YunoHost pour cette app : <https://yunohost.org/app_timemachine>
 * Signaler un bug : <https://github.com/YunoHost-Apps/timemachine_ynh/issues>