improve some docs and disable telemetry server by default

.github/workflows/docker.yml

@@ -152,7 +152,7 @@ jobs:
             INSTALL_OPTIONAL_PACKAGES=${{ steps.info.outputs.full }}
           labels: |
             org.opencontainers.image.title=SFTPGo
-            org.opencontainers.image.description=Fully featured and highly configurable SFTP server with optional FTP/S and WebDAV support
+            org.opencontainers.image.description=Fully featured and highly configurable SFTP server with optional HTTP, FTP/S and WebDAV support
             org.opencontainers.image.url=https://github.com/drakkan/sftpgo
             org.opencontainers.image.documentation=https://github.com/drakkan/sftpgo/blob/${{ github.sha }}/docker/README.md
             org.opencontainers.image.source=https://github.com/drakkan/sftpgo

docs/full-configuration.md

@@ -246,7 +246,7 @@ The configuration file contains the following sections:
     - `allow_credentials` boolean.
     - `max_age`, integer.
 - **"telemetry"**, the configuration for the telemetry server, more details [below](#telemetry-server)
-  - `bind_port`, integer. The port used for serving HTTP requests. Set to 0 to disable HTTP server. Default: 10000
+  - `bind_port`, integer. The port used for serving HTTP requests. Set to 0 to disable HTTP server. Default: 0
   - `bind_address`, string. Leave blank to listen on all available network interfaces. On \*NIX you can specify an absolute path to listen on a Unix-domain socket. Default: "127.0.0.1"
   - `enable_profiler`, boolean. Enable the built-in profiler. Default `false`
   - `auth_user_file`, string. Path to a file used to store usernames and passwords for basic authentication. This can be an absolute path or a path relative to the config dir. We support HTTP basic authentication, and the file format must conform to the one generated using the Apache `htpasswd` tool. The supported password formats are bcrypt (`$2y$` prefix) and md5 crypt (`$apr1$` prefix). If empty, HTTP authentication is disabled. Authentication will be always disabled for the `/healthz` endpoint.

docs/howto/getting-started.md

@@ -47,7 +47,7 @@ From the `Status` page you see the active services.
 
 ![Status](./img/status.png)
 
-The default configuration enables the SFTP service on port `2022` and uses `SQLite` as data provider.
+The default configuration enables the SFTP service on port `2022` and uses an embedded data provider (`SQLite` or `bolt` based on the target OS and architecture).
 
 ## Creating users
 

pkgs/build.sh

@@ -56,7 +56,7 @@ priority: "optional"
 maintainer: "Nicola Murino <nicola.murino@gmail.com>"
 description: |
   Fully featured and highly configurable SFTP server
-  SFTPGo has optional FTP/S and WebDAV support.
+  SFTPGo has optional HTTP, FTP/S and WebDAV support.
   It can serve local filesystem, S3 (Compatible) Object Storage,
   Google Cloud Storage, Azure Blob Storage, SFTP.
 vendor: "SFTPGo"

sftpgo.json

@@ -236,7 +236,7 @@
     }
   },
   "telemetry": {
-    "bind_port": 10000,
+    "bind_port": 0,
     "bind_address": "127.0.0.1",
     "enable_profiler": false,
     "auth_user_file": "",

windows-installer/README.txt

@@ -0,0 +1,34 @@
+SFTPGo allows to securely share your files over SFTP, HTTP and optionally FTP/S and WebDAV as well.
+Several storage backends are supported: local filesystem, encrypted local filesystem, S3 (compatible) Object Storage, Google Cloud Storage, Azure Blob Storage, other SFTP servers.
+
+If this is your first installation please open the web administration panel:
+
+http://localhost:8080/web/admin
+
+and complete the initial setup.
+
+The SFTP service is available, by default, on port 2022.
+
+Default data location:
+
+C:\ProgramData\SFTPGo
+
+Default configuration file location:
+
+C:\ProgramData\SFTPGo\sftpgo.json
+
+Getting started guide:
+
+https://github.com/drakkan/sftpgo/blob/main/docs/howto/getting-started.md
+
+Source code and documentation:
+
+https://github.com/drakkan/sftpgo
+
+If you find a bug please open an issue:
+
+https://github.com/drakkan/sftpgo/issues
+
+If you want to suggest a new feature or have a question, please start a new discussion:
+
+https://github.com/drakkan/sftpgo/discussions

windows-installer/sftpgo.iss

@@ -67,6 +67,7 @@ Source: "{#MyAppDir}\sftpgo.json"; DestDir: "{commonappdata}\{#MyAppName}"; Flag
 Source: "{#MyAppDir}\templates\*"; DestDir: "{commonappdata}\{#MyAppName}\templates"; Flags: ignoreversion recursesubdirs createallsubdirs
 Source: "{#MyAppDir}\static\*"; DestDir: "{commonappdata}\{#MyAppName}\static"; Flags: ignoreversion recursesubdirs createallsubdirs
 Source: "{#MyAppDir}\openapi\*"; DestDir: "{commonappdata}\{#MyAppName}\openapi"; Flags: ignoreversion recursesubdirs createallsubdirs
+Source: "README.txt"; DestDir: "{app}"; Flags: ignoreversion isreadme
 
 [Dirs]
 Name: "{commonappdata}\{#MyAppName}\logs"; Permissions: everyone-full
@@ -74,9 +75,9 @@ Name: "{commonappdata}\{#MyAppName}\backups"; Permissions: everyone-full
 Name: "{commonappdata}\{#MyAppName}\credentials"; Permissions: everyone-full
 
 [Icons]
-Name: "{group}\Web Admin"; Filename: "http://127.0.0.1:8080/web/admin";
+Name: "{group}\Web Admin"; Filename: "http://localhost:8080/web/admin";
-Name: "{group}\Web Client"; Filename: "http://127.0.0.1:8080/web/client";
+Name: "{group}\Web Client"; Filename: "http://localhost:8080/web/client";
-Name: "{group}\OpenAPI"; Filename: "http://127.0.0.1:8080/openapi";
+Name: "{group}\OpenAPI"; Filename: "http://localhost:8080/openapi";
 Name: "{group}\Service Control";  WorkingDir: "{app}"; Filename: "powershell.exe"; Parameters: "-Command ""Start-Process cmd \""/k cd {app} & {#MyAppExeName} service --help\"" -Verb RunAs"; Comment: "Manage SFTPGo Service"
 Name: "{group}\Documentation"; Filename: "{#DocURL}";
 Name: "{group}\{cm:UninstallProgram,{#MyAppName}}"; Filename: "{uninstallexe}"
@@ -93,3 +94,6 @@ Filename: "{app}\{#MyAppExeName}"; Parameters: "service start";  Description: "S
 Filename: "{app}\{#MyAppExeName}"; Parameters: "service stop"; Flags: runhidden; RunOnceId: "Stop SFTPGo service"
 Filename: "{app}\{#MyAppExeName}"; Parameters: "service uninstall"; Flags: runhidden; RunOnceId: "Uninstall SFTPGo service"
 Filename: "netsh"; Parameters: "advfirewall firewall delete rule name=""SFTPGo Service"""; Flags: runhidden; RunOnceId: "Remove SFTPGo firewall rule"
+
+[Messages]
+FinishedLabel=Setup has finished installing SFTPGo on your computer. SFTPGo should already be running as a Windows service, it uses TCP port 8080 for HTTP service and TCP port 2022 for SFTP service by default, make sure the configured ports are not used by other services or edit the configuration according to your needs.