docs: replace the images relating to the old theme

Signed-off-by: Nicola Murino <[email protected]>
drakkan · Feb 18, 2024 · e5fc1bd · e5fc1bd
1 parent aaf310f
commit e5fc1bd
Show file tree

Hide file tree

Showing 58 changed files with 60 additions and 44 deletions.
diff --git a/docs/howto/getting-started.md b/docs/howto/getting-started.md
@@ -36,7 +36,7 @@ Before you can use SFTPGo you need to create an admin account, so open [http://1
 
 ![Setup](./img/setup.png)
 
-After creating the admin account you will be automatically logged in.
+After creating the admin account you will be automatically logged in and redirected to the page to set up two-factor authentication. Setting up two-factor authentication is optional.
 
 ![Users list](./img/initial-screen.png)
 
@@ -57,7 +57,7 @@ Let's create our first local user:
 - from the `Users` page click the `+` icon to open the `Add user page`
 - the only required fields are the `Username` and a `Password` or a `Public key`
 - if you are on Windows or you installed SFTPGo manually and no `users_base_dir` is defined in your configuration file you also have to set a `Home Dir`. It must be an absolute path, for example `/srv/sftpgo/data/username` on Linux or `C:\sftpgo\data\username` on Windows. SFTPGo will try to automatically create the home directory, if missing, when the user logs in. Each user can only access files and folders inside its home directory.
-- click `Submit`
+- click `Save`
 
 ![Add user](./img/add-user.png)
 

diff --git a/docs/howto/img/add-folder.png b/docs/howto/img/add-folder.png
diff --git a/docs/howto/img/add-group.png b/docs/howto/img/add-group.png
diff --git a/docs/howto/img/add-user-simplified.png b/docs/howto/img/add-user-simplified.png
diff --git a/docs/howto/img/add-user.png b/docs/howto/img/add-user.png
diff --git a/docs/howto/img/admin-2FA-login.png b/docs/howto/img/admin-2FA-login.png
diff --git a/docs/howto/img/admin-2FA.png b/docs/howto/img/admin-2FA.png
diff --git a/docs/howto/img/admin-save-2FA.png b/docs/howto/img/admin-save-2FA.png
diff --git a/docs/howto/img/az-user-1.png b/docs/howto/img/az-user-1.png
diff --git a/docs/howto/img/az-user-2.png b/docs/howto/img/az-user-2.png
diff --git a/docs/howto/img/backup-action.png b/docs/howto/img/backup-action.png
diff --git a/docs/howto/img/backup-notification-action.png b/docs/howto/img/backup-notification-action.png
diff --git a/docs/howto/img/create-dirs-action.png b/docs/howto/img/create-dirs-action.png
diff --git a/docs/howto/img/create-dirs-failure-notification.png b/docs/howto/img/create-dirs-failure-notification.png
diff --git a/docs/howto/img/create-dirs-rule-actions.png b/docs/howto/img/create-dirs-rule-actions.png
diff --git a/docs/howto/img/create-dirs-rule.png b/docs/howto/img/create-dirs-rule.png
diff --git a/docs/howto/img/daily-backup-actions.png b/docs/howto/img/daily-backup-actions.png
diff --git a/docs/howto/img/daily-backup-schedule.png b/docs/howto/img/daily-backup-schedule.png
diff --git a/docs/howto/img/folders.png b/docs/howto/img/folders.png
diff --git a/docs/howto/img/gcs-user.png b/docs/howto/img/gcs-user.png
diff --git a/docs/howto/img/initial-screen.png b/docs/howto/img/initial-screen.png
diff --git a/docs/howto/img/local-encrypted.png b/docs/howto/img/local-encrypted.png
diff --git a/docs/howto/img/primary-group-settings.png b/docs/howto/img/primary-group-settings.png
diff --git a/docs/howto/img/read-only-share.png b/docs/howto/img/read-only-share.png
diff --git a/docs/howto/img/recycle-folder.png b/docs/howto/img/recycle-folder.png
diff --git a/docs/howto/img/recycle-group.png b/docs/howto/img/recycle-group.png
diff --git a/docs/howto/img/recycle-move-action.png b/docs/howto/img/recycle-move-action.png
diff --git a/docs/howto/img/recycle-rule-path.png b/docs/howto/img/recycle-rule-path.png
diff --git a/docs/howto/img/recycle-rule.png b/docs/howto/img/recycle-rule.png
diff --git a/docs/howto/img/s3-key-prefix.png b/docs/howto/img/s3-key-prefix.png
diff --git a/docs/howto/img/s3-private-folder.png b/docs/howto/img/s3-private-folder.png
diff --git a/docs/howto/img/s3-user-1.png b/docs/howto/img/s3-user-1.png
diff --git a/docs/howto/img/s3-user-2.png b/docs/howto/img/s3-user-2.png
diff --git a/docs/howto/img/setup.png b/docs/howto/img/setup.png
diff --git a/docs/howto/img/sftp-user.png b/docs/howto/img/sftp-user.png
diff --git a/docs/howto/img/simplified-admin.png b/docs/howto/img/simplified-admin.png
diff --git a/docs/howto/img/status.png b/docs/howto/img/status.png
diff --git a/docs/howto/img/upload-notification.png b/docs/howto/img/upload-notification.png
diff --git a/docs/howto/img/upload-rule.png b/docs/howto/img/upload-rule.png
diff --git a/docs/howto/img/user-2FA-disabled.png b/docs/howto/img/user-2FA-disabled.png
diff --git a/docs/howto/img/user-2FA-login.png b/docs/howto/img/user-2FA-login.png
diff --git a/docs/howto/img/user-save-2FA.png b/docs/howto/img/user-save-2FA.png
diff --git a/docs/howto/img/virtual-folders.png b/docs/howto/img/virtual-folders.png
diff --git a/docs/howto/img/virtual-permissions.png b/docs/howto/img/virtual-permissions.png
diff --git a/docs/howto/img/web-client-files.png b/docs/howto/img/web-client-files.png
diff --git a/docs/howto/img/web-client-two-factor-auth.png b/docs/howto/img/web-client-two-factor-auth.png
diff --git a/docs/howto/two-factor-authentication.md b/docs/howto/two-factor-authentication.md
@@ -41,10 +41,12 @@ Each admin can view/change his/her two-factor authentication by selecting the `T
 
 ![Admin 2FA](./img/admin-2FA.png)
 
-Then select a configuration and click "Generate new secret". A QR code will be generated which you can scan with a compatible app. After you configured your app, enter a test code to ensure everything works correctly and click on "Verify and save".
+Then select a configuration and click "Generate new secret key". A QR code will be generated which you can scan with a compatible app. After you configured your app, enter a test code to ensure everything works correctly and click on "Save".
 
 ![Enable 2FA](./img/admin-save-2FA.png)
 
+Then save the configuration.
+
 SFTPGo automatically generates some recovery codes. They are a set of one time use codes that can be used in place of the TOTP to login to the web UI. You can use them if you lose access to your phone to login to your account and disable or regenerate TOTP configuration.
 
 2FA is now enabled, so the next time you login with this admin you have to provide a valid authentication code after your password.
@@ -82,10 +84,12 @@ HTTP protocol means Web UI and REST APIs. Web UI will ask for the passcode using
 
 FTP has no standard way to support two factor authentication, if you enable the FTP protocol, you have to add the TOTP passcode after the password. For example if your password is "password" and your one time passcode is "123456" you have to use "password123456" as password.
 
-To enable 2FA select the wanted protocols, a configuration and click "Generate new secret". A QR code will be generated which you can scan with a compatible app. After you configured your app, enter a test code to ensure everything works correctly and click on "Verify and save".
+To enable 2FA select the wanted protocols, a configuration and click "Generate new secret key". A QR code will be generated which you can scan with a compatible app. After you configured your app, enter a test code to ensure everything works correctly and click on "Save".
 
 ![Enable 2FA](./img/user-save-2FA.png)
 
+Then save the configuration.
+
 SFTPGo automatically generates some recovery codes. They are a set of one time use codes that can be used in place of the TOTP to login to the web UI. You can use them if you lose access to your phone to login to your account and disable or regenerate TOTP configuration.
 
 2FA is now enabled, so the next time you login with this user you have to provide a valid authentication code after your password.

diff --git a/static/locales/en/translation.json b/static/locales/en/translation.json
@@ -167,7 +167,7 @@
         "api_key_auth": "API key authentication",
         "api_key_auth_help": "Allow to impersonate yourself, in REST API, using an API key",
         "pub_keys": "Public keys",
-        "pub_key_placeholder": "Paste your public key here",
+        "pub_key_placeholder": "Paste a public key here",
         "verify": "Verify",
         "problems": "Having problems?",
         "allowed_ip_mask": "Allowed IP/Mask",
@@ -522,7 +522,7 @@
         "expires_in": "Expires in",
         "expires_in_help": "Account expiration as number of days from the creation. 0 means no expiration",
         "tls_certs": "TLS certificates",
-        "tls_cert_help": "Paste your PEM encoded TLS certificate here",
+        "tls_cert_help": "Paste a PEM encoded TLS certificate here",
         "tls_cert_invalid": "Invalid TLS certificate",
         "template_title": "Create one or more new users from this template",
         "template_username_placeholder": "replaced with the specified username",
@@ -533,7 +533,8 @@
     },
     "group": {
         "view_manage": "View and manage groups",
-        "err_delete_referenced": "Cannot delete a group with associated users, remove associations first"
+        "err_delete_referenced": "Cannot delete a group with associated users, remove associations first",
+        "help": "The %username% placeholder will be replaced with the username of the associated users"
     },
     "virtual_folders": {
         "view_manage": "View and manage virtual folders",

diff --git a/static/locales/it/translation.json b/static/locales/it/translation.json
@@ -167,7 +167,7 @@
         "api_key_auth": "Autenticazione mediante chiave API",
         "api_key_auth_help": "Permetti di impersonarti nelle API REST utilizzando una chiave API",
         "pub_keys": "Chiavi pubbliche",
-        "pub_key_placeholder": "Incolla qui la tua chiave pubblica",
+        "pub_key_placeholder": "Incolla qui una chiave pubblica",
         "verify": "Verifica",
         "problems": "Hai problemi?",
         "allowed_ip_mask": "IP/Reti permesse",
@@ -522,7 +522,7 @@
         "expires_in": "Scadenza",
         "expires_in_help": "Scadenza dell'account espressa in numero di giorni dalla creazione. 0 significa nessuna scadenza",
         "tls_certs": "Certificati TLS",
-        "tls_cert_help": "Incolla qui il tuo certificato TLS codificato PEM",
+        "tls_cert_help": "Incolla qui un tuo certificato TLS codificato PEM",
         "tls_cert_invalid": "Certificato TLS non valido",
         "template_title": "Crea uno o più nuovi utenti da questo modello",
         "template_username_placeholder": "sostituito con il nome utente specificato",
@@ -533,7 +533,8 @@
     },
     "group": {
         "view_manage": "Visualizza e gestisci gruppi",
-        "err_delete_referenced": "Impossibile eliminare un gruppo con utenti associati, rimuovere prima le associazioni"
+        "err_delete_referenced": "Impossibile eliminare un gruppo con utenti associati, rimuovere prima le associazioni",
+        "help": "Il segnaposto %username% verrà sostituito con il nome utente degli utenti associati"
     },
     "virtual_folders": {
         "view_manage": "Visualizza e gestisci cartelle virtuali",

diff --git a/templates/common/base.html b/templates/common/base.html
@@ -732,6 +732,16 @@
 {{- end}}
 
 {{- define "infomsg"}}
+<div class="notice d-flex bg-light-primary rounded border-primary border border-dashed p-4 mb-10">
+    <div class="d-flex flex-stack flex-grow-1">
+        <div class="fs-5 fw-semibold text-break text-wrap text-gray-800">
+            <span data-i18n="{{.}}"></span>
+        </div>
+    </div>
+</div>
+{{- end}}
+
+{{- define "infomsg-no-mb"}}
 <div class="notice d-flex bg-light-primary rounded border-primary border border-dashed p-4">
     <div class="d-flex flex-stack flex-grow-1">
         <div class="fs-5 fw-semibold text-break text-wrap text-gray-800">

diff --git a/templates/common/changepassword.html b/templates/common/changepassword.html
@@ -21,11 +21,10 @@
         <h3 data-i18n="title.change_password" class="card-title section-title">Change password</h3>
     </div>
     <div class="card-body">
-        {{template "infomsg" "change_pwd.info"}}
-
+        {{- template "infomsg" "change_pwd.info"}}
         {{- template "errmsg" .Error}}
         <form id="change_pwd_form" action="{{.CurrentURL}}" method="POST" autocomplete="off">
-            <div class="form-group row mt-10">
+            <div class="form-group row">
                 <label data-i18n="change_pwd.current" class="col-md-3 col-form-label required">Current password</label>
                 <div class="col-md-9">
                     <div class="position-relative" data-password-control="container">

diff --git a/templates/webadmin/admin.html b/templates/webadmin/admin.html
@@ -69,8 +69,8 @@ <h3 data-i18n="{{.Title}}" class="card-title section-title"></h3>
                     <h3 data-i18n="general.role" class="card-title section-title-inner">Role</h3>
                 </div>
                 <div class="card-body">
-                    {{template "infomsg" "admin.role_help"}}
-                    <div class="form-group row mt-10">
+                    {{- template "infomsg" "admin.role_help"}}
+                    <div class="form-group row">
                         <label for="idRole" data-i18n="general.role" class="col-md-3 col-form-label">Role</label>
                         <div class="col-md-9">
                             <select id="idRole" name="role" data-i18n="[data-placeholder]general.role_placeholder" class="form-select" data-control="i18n-select2" data-placeholder="Select a role" data-allow-clear="true">
@@ -92,7 +92,7 @@ <h3 data-i18n="admin.users_groups" class="card-title section-title-inner">Groups
                 </div>
                 <div class="card-body">
                     <div id="groups">
-                        {{template "infomsg" "admin.users_groups_help"}}
+                        {{- template "infomsg-no-mb" "admin.users_groups_help"}}
                         <div class="form-group">
                             <div data-repeater-list="groups">
                                 {{range $idx, $val := .Admin.Groups}}
@@ -181,9 +181,9 @@ <h3 data-i18n="admin.users_groups" class="card-title section-title-inner">Groups
                     <h3 data-i18n="admin.user_page_pref" class="card-title section-title-inner">User page preferences</h3>
                 </div>
                 <div class="card-body">
-                    {{template "infomsg" "admin.user_page_pref_help"}}
+                    {{- template "infomsg" "admin.user_page_pref_help"}}
 
-                    <div class="form-group row mt-10">
+                    <div class="form-group row">
                         <label for="idUserPageHiddenSections" data-i18n="admin.hide_sections" class="col-md-3 col-form-label">Hide sections</label>
                         <div class="col-md-9">
                             <select id="idUserPageHiddenSections" name="user_page_hidden_sections" class="form-select" data-control="i18n-select2" data-hide-search="true" data-close-on-select="false" multiple>

diff --git a/templates/webadmin/configs.html b/templates/webadmin/configs.html
@@ -31,10 +31,10 @@ <h2 class="accordion-header" id="accordion_header_sftp">
                 </h2>
                 <div id="accordion_sftp_body" class="accordion-collapse collapse {{if eq .ConfigSection 1}}show{{end}}" aria-labelledby="accordion_header_sftp" data-bs-parent="#accordion_configs">
                     <div class="accordion-body">
-                        {{template "infomsg" "sftp.help"}}
+                        {{- template "infomsg" "sftp.help"}}
 
                         <form id="configs_sftp_form" action="{{.CurrentURL}}" method="POST" autocomplete="off">
-                            <div class="form-group row mt-10">
+                            <div class="form-group row">
                                 <label for="idHostKeyAlgos" data-i18n="sftp.host_key_algos" class="col-md-3 col-form-label">
                                     Host Key Algos
                                 </label>
@@ -126,11 +126,11 @@ <h2 class="accordion-header" id="accordion_header_acme">
                 </h2>
                 <div id="accordion_acme_body" class="accordion-collapse collapse {{if eq .ConfigSection 2}}show{{end}}" aria-labelledby="accordion_header_acme" data-bs-parent="#accordion_configs">
                     <div class="accordion-body">
-                        {{template "infomsg" "acme.help"}}
+                        {{- template "infomsg" "acme.help"}}
 
                         <form id="configs_acme_form" action="{{.CurrentURL}}" method="POST" autocomplete="off">
 
-                            <div class="form-group row mt-10">
+                            <div class="form-group row">
                                 <label for="idACMEDomain" data-i18n="general.domain" class="col-md-3 col-form-label">Domain</label>
                                 <div class="col-md-9">
                                     <input id="idACMEDomain" type="text" class="form-control" name="acme_domain" value="{{.Configs.ACME.Domain}}" aria-describedby="idACMEDomainHelp" />
@@ -195,11 +195,11 @@ <h2 class="accordion-header" id="accordion_header_smtp">
                 </h2>
                 <div id="accordion_smtp_body" class="accordion-collapse collapse {{if eq .ConfigSection 3}}show{{end}}" aria-labelledby="accordion_header_smtp" data-bs-parent="#accordion_configs">
                     <div class="accordion-body">
-                        {{template "infomsg" "smtp.help"}}
+                        {{- template "infomsg" "smtp.help"}}
 
                         <form id="configs_smtp_form" action="{{.CurrentURL}}" method="POST" autocomplete="off">
 
-                            <div class="form-group row mt-10">
+                            <div class="form-group row">
                                 <label for="idSMTPHost" data-i18n="smtp.host" class="col-md-3 col-form-label">Server name</label>
                                 <div class="col-md-5">
                                     <input id="idSMTPHost" type="text" class="form-control" name="smtp_host" value="{{.Configs.SMTP.Host}}" maxlength="512" spellcheck="false" aria-describedby="idSMTPHostHelp" />

diff --git a/templates/webadmin/eventaction.html b/templates/webadmin/eventaction.html
@@ -295,7 +295,7 @@ <h3 data-i18n="actions.multipart_body" class="card-title section-title-inner">Mu
                 </div>
                 <div class="card-body">
                     <div id="multipart_body">
-                        {{template "infomsg" "actions.multipart_body_help"}}
+                        {{- template "infomsg-no-mb" "actions.multipart_body_help"}}
                         <div class="form-group">
                             <div data-repeater-list="multipart_body">
                                 {{- range $idx, $val := .Action.Options.HTTPConfig.Parts}}
@@ -411,7 +411,7 @@ <h3 data-i18n="general.env_vars" class="card-title section-title-inner">Environm
                 </div>
                 <div class="card-body">
                     <div id="env_vars">
-                        {{template "infomsg" "actions.command_env_vars_help"}}
+                        {{- template "infomsg-no-mb" "actions.command_env_vars_help"}}
                         <div class="form-group">
                             <div data-repeater-list="env_vars">
                                 {{- range $idx, $val := .Action.Options.CmdConfig.EnvVars}}
@@ -536,7 +536,7 @@ <h3 data-i18n="actions.data_retention" class="card-title section-title-inner">Da
                 </div>
                 <div class="card-body">
                     <div id="data_retention">
-                        {{template "infomsg" "actions.data_retention_help"}}
+                        {{- template "infomsg-no-mb" "actions.data_retention_help"}}
                         <div class="form-group">
                             <div data-repeater-list="data_retention">
                                 {{- range $idx, $val := .Action.Options.RetentionConfig.Folders}}
@@ -632,7 +632,7 @@ <h3 data-i18n="actions.fs_types.rename" class="card-title section-title-inner">R
                 </div>
                 <div class="card-body">
                     <div id="fs_rename">
-                        {{template "infomsg" "actions.paths_src_dst_help"}}
+                        {{- template "infomsg-no-mb" "actions.paths_src_dst_help"}}
                         <div class="form-group">
                             <div data-repeater-list="fs_rename">
                                 {{- range $idx, $val := .Action.Options.FsConfig.Renames}}
@@ -730,7 +730,7 @@ <h3 data-i18n="actions.fs_types.copy" class="card-title section-title-inner">Cop
                 </div>
                 <div class="card-body">
                     <div id="fs_copy">
-                        {{template "infomsg" "actions.paths_src_dst_help"}}
+                        {{- template "infomsg-no-mb" "actions.paths_src_dst_help"}}
                         <div class="form-group">
                             <div data-repeater-list="fs_copy">
                                 {{- range $idx, $val := .Action.Options.FsConfig.Copy}}