feature (whitelabel): remove references to Filestash

mickael-kerjean · mickael-kerjean · commit 86c5f51be1ac · 2026-01-27T17:28:20.000+11:00
diff --git a/public/assets/index.js b/public/assets/index.js
@@ -1,7 +1,7 @@
-// Want to integrate Filestash as a SDK in your application? You are in the right place!
+// Want to create an integration via our SDK in your application? You are in the right place!
 //
 // How it works you may ask? it's simple:
-// 1) pick a component to render. Filestash components look like this:
+// 1) pick a component to render. Components look like this:
 //    function(render, opts = {}) {
 //        // ...
 //    }
@@ -12,8 +12,8 @@
 // /***********************************************/
 // /* example to render the 3D viewer application */
 // /***********************************************/
-// import { render } from "https://demo.filestash.app/assets/index.js";
-// import * as Component from "https://demo.filestash.app/assets/pages/viewerpage/application_3d.js";
+// import { render } from "<YOUR_INSTANCE_URL>/assets/index.js";
+// import * as Component from "<YOUR_INSTANCE_URL>/assets/pages/viewerpage/application_3d.js";
 //
 // render(Component, document.getElementById("app"), {});
 //
@@ -28,8 +28,8 @@ export function render(module, $app, opts = {}) {
 }
 
 function assertArgs(module, $app) {
-    if (typeof module.default !== "function") throw new TypeError("Unsupported module - see documentation on how to use Filestash");
-    else if (!($app instanceof Node)) throw new TypeError("Invalid node - see documentation on how to use Filestash");
+    if (typeof module.default !== "function") throw new TypeError("Unsupported module - see the SDK documentation");
+    else if (!($app instanceof Node)) throw new TypeError("Invalid node - see the SDK documentation");
 }
 
 function execute(module, $app, opts) {
diff --git a/public/assets/pages/connectpage/ctrl_forkme.js b/public/assets/pages/connectpage/ctrl_forkme.js
@@ -4,7 +4,7 @@ import rxjs from "../../lib/rx.js";
 import config$ from "./model_config.js";
 
 export default async function(render) {
-    const hasFork = await config$.pipe(rxjs.filter(({ fork_button }) => fork_button !== false)).toPromise();
+    const hasFork = await config$.pipe(rxjs.filter(({ license }) => license === "agpl")).toPromise();
     if (!hasFork) return;
 
     render(createElement(`
diff --git a/public/assets/pages/connectpage/ctrl_poweredby.js b/public/assets/pages/connectpage/ctrl_poweredby.js
@@ -6,7 +6,7 @@ import t from "../../locales/index.js";
 import config$ from "./model_config.js";
 
 export default async function(render) {
-    const hasFork = await config$.pipe(rxjs.filter(({ fork_button }) => fork_button !== false)).toPromise();
+    const hasFork = await config$.pipe(rxjs.filter(({ license }) => license === "agpl")).toPromise();
     if (!hasFork) return;
 
     await new Promise((done) => setTimeout(done, 1000));
diff --git a/public/index.frontoffice.html b/public/index.frontoffice.html
@@ -1,4 +1,4 @@
-{{ if eq .license "agpl" -}}
+{{ if .appname | eq "Filestash" }}
 <!--
     ┌──────────────────────────────────────────────────────────┐
     │                       FILESTASH                          │
@@ -16,9 +16,9 @@
         {{- end }}
         <link rel="preload" as="style" href="custom.css" onload="this.rel='stylesheet'">
         <meta http-equiv="X-UA-Compatible" content="IE=edge">
-        <meta name="application-name" content="Filestash">
+        <meta name="application-name" content="{{ .appname }}">
         <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
-        <script>{{ if eq .license "agpl" }}{{ template "loader-cat" }}{{ else }}{{ template "loader-basic" }}{{ end }}</script>
+        <script>{{ if .license | eq "agpl" }}{{ template "loader-cat" }}{{ else }}{{ template "loader-basic" }}{{ end }}</script>
     </head>
     <body>
         <div id="app"><component-bootscreen></component-bootscreen></div>
diff --git a/server/common/config.go b/server/common/config.go
@@ -67,13 +67,12 @@ func NewConfiguration() Configuration {
 			Form{
 				Title: "general",
 				Elmnts: []FormElement{
-					FormElement{Name: "name", Type: "text", Default: "Filestash", Description: "Name has shown in the UI", Placeholder: "Default: \"Filestash\""},
+					FormElement{Name: "name", Type: "text", Default: APPNAME, Description: "Name has shown in the UI", Placeholder: "Default: \"" + APPNAME + "\""},
 					FormElement{Name: "port", Type: "number", Default: 8334, Description: "Port on which the application is available.", Placeholder: "Default: 8334"},
 					FormElement{Name: "host", Type: "text", Description: "The host people need to use to access this server", Placeholder: "Eg: \"demo.filestash.app\""},
 					FormElement{Name: "secret_key", Type: "password", Required: true, Pattern: "[a-zA-Z0-9]{16}", Description: "The key that's used to encrypt and decrypt content. Update this settings will invalidate existing user sessions and shared links, use with caution!"},
 					FormElement{Name: "force_ssl", Type: "boolean", Description: "Enable the web security mechanism called 'Strict Transport Security'"},
 					FormElement{Name: "editor", Type: "select", Default: "emacs", Opts: []string{"base", "emacs", "vim"}, Description: "Keybinding to be use in the editor. Default: \"emacs\""},
-					FormElement{Name: "fork_button", Type: "boolean", Default: true, Description: "Display the fork button in the login screen"},
 					FormElement{Name: "logout", Type: "text", Default: "", Description: "Redirection URL whenever user click on the logout button"},
 					FormElement{Name: "display_hidden", Type: "boolean", Default: false, Description: "Should files starting with a dot be visible by default?"},
 					FormElement{Name: "refresh_after_upload", Type: "boolean", Default: false, Description: "Refresh directory listing after upload"},
@@ -108,7 +107,7 @@ func NewConfiguration() Configuration {
 					Form{
 						Title: "protection",
 						Elmnts: []FormElement{
-							FormElement{Name: "iframe", Type: "text", Default: "", Description: "list of domains who can use the application from an iframe. eg: https://www.filestash.app http://example.com"},
+							FormElement{Name: "iframe", Type: "text", Default: "", Description: "list of domains who can use the application from an iframe. eg: https://example.com"},
 							FormElement{Name: "enable_chromecast", Type: "boolean", Default: true, Description: "Enable users to stream content on a chromecast device. This feature requires the browser to access google's server to download the chromecast SDK."},
 							FormElement{Name: "signature", Type: "text", Default: "", Description: "Enforce signature when using URL parameters in the authentication process"},
 						},
@@ -120,7 +119,7 @@ func NewConfiguration() Configuration {
 				Elmnts: []FormElement{
 					FormElement{Name: "enable", Type: "enable", Target: []string{"log_level"}, Default: true},
 					FormElement{Name: "level", Type: "select", Default: defaultValue("INFO", "LOG_LEVEL"), Opts: []string{"DEBUG", "INFO", "WARNING", "ERROR"}, Id: "log_level", Description: "Default: \"INFO\". This setting determines the level of detail at which log events are written to the log file"},
-					FormElement{Name: "telemetry", Type: "boolean", Default: false, Description: "We won't share anything with any third party. This will only to be used to improve Filestash"},
+					FormElement{Name: "telemetry", Type: "boolean", Default: false, Description: "We won't share anything with any third party. This will only to be used to improve our software"},
 				},
 			},
 			Form{
@@ -337,7 +336,7 @@ func (this *Configuration) Save() {
 func (this *Configuration) Export() interface{} {
 	return struct {
 		Editor                  string            `json:"editor"`
-		ForkButton              bool              `json:"fork_button"`
+		License                 string            `json:"license"`
 		DisplayHidden           bool              `json:"display_hidden"`
 		Name                    string            `json:"name"`
 		UploadButton            bool              `json:"upload_button"`
@@ -360,7 +359,7 @@ func (this *Configuration) Export() interface{} {
 		EnableTags              bool              `json:"enable_tags"`
 	}{
 		Editor:                  this.Get("general.editor").String(),
-		ForkButton:              this.Get("general.fork_button").Bool(),
+		License:                 LICENSE,
 		DisplayHidden:           this.Get("general.display_hidden").Bool(),
 		Name:                    this.Get("general.name").String(),
 		UploadButton:            this.Get("general.upload_button").Bool(),
diff --git a/server/common/config_state.go b/server/common/config_state.go
@@ -79,8 +79,8 @@ func SaveConfig(v []byte) error {
 	file, err := os.Create(config_path())
 	if err != nil {
 		return fmt.Errorf(
-			"Filestash needs to be able to create/edit its own configuration which it can't at the moment. "+
-				"Change the permission for filestash to create and edit `%s`",
+			APPNAME+" needs to be able to create and edit its configuration, but it currently cannot. "+
+				"Change the permissions to allow writing to `%s`",
 			config_path(),
 		)
 	}
diff --git a/server/common/constants.go b/server/common/constants.go
@@ -56,6 +56,7 @@ func init() {
 }
 
 var (
+	APPNAME                           string = "Filestash"
 	BUILD_REF                         string
 	BUILD_DATE                        string
 	LICENSE                           string = "agpl"
@@ -103,3 +104,7 @@ func env(key string, val string) string {
 	}
 	return val
 }
+
+func IsWhiteLabel() bool {
+	return APPNAME != "Filestash"
+}
diff --git a/server/common/default.go b/server/common/default.go
@@ -10,6 +10,12 @@ import (
 
 var USER_AGENT = fmt.Sprintf("Filestash/%s.%s (http://filestash.app)", APP_VERSION, BUILD_DATE)
 
+func init() {
+	if IsWhiteLabel() {
+		USER_AGENT = fmt.Sprintf(APPNAME)
+	}
+}
+
 var HTTPClient = http.Client{
 	Timeout: 5 * time.Hour,
 	Transport: NewTransformedTransport(&http.Transport{
diff --git a/server/ctrl/report.go b/server/ctrl/report.go
@@ -14,6 +14,10 @@ func ReportHandler(ctx *App, res http.ResponseWriter, req *http.Request) {
 }
 
 func WellKnownSecurityHandler(ctx *App, res http.ResponseWriter, req *http.Request) {
+	if IsWhiteLabel() {
+		NotFoundHandler(ctx, res, req)
+		return
+	}
 	res.WriteHeader(http.StatusOK)
 	res.Write([]byte("# If you would like to report a security issue\n"))
 	res.Write([]byte("# you may report it to me via email\n"))
diff --git a/server/ctrl/static.go b/server/ctrl/static.go
@@ -238,6 +238,7 @@ func ServeIndex(indexPath string) func(*App, http.ResponseWriter, *http.Request)
 		sign := signature()
 		base := WithBase("/")
 		templateData := map[string]any{
+			"appname": APPNAME,
 			"base":    base,
 			"version": BUILD_REF,
 			"license": LICENSE,
diff --git a/server/middleware/http.go b/server/middleware/http.go
@@ -51,7 +51,9 @@ func IndexHeaders(fn HandlerFunc) HandlerFunc {
 		header.Set("Referrer-Policy", "same-origin")
 		header.Set("X-Content-Type-Options", "nosniff")
 		header.Set("X-XSS-Protection", "1; mode=block")
-		header.Set("X-Powered-By", fmt.Sprintf("Filestash/%s.%s <https://filestash.app>", APP_VERSION, BUILD_DATE))
+		if !IsWhiteLabel() {
+			header.Set("X-Powered-By", fmt.Sprintf("Filestash/%s.%s <https://filestash.app>", APP_VERSION, BUILD_DATE))
+		}
 		if ori := Config.Get("features.protection.iframe").String(); ori == "" {
 			header.Set("X-Frame-Options", "DENY")
 		}
diff --git a/server/plugin/plg_authenticate_local/auth.go b/server/plugin/plg_authenticate_local/auth.go
@@ -64,8 +64,8 @@ EMAIL SERVER: %t
 				Type: "long_text",
 				Placeholder: `Hello,
 
-Your account to Filestash was created by an administrator. You can access
-it via http://demo.filestash.app.
+Your account was created by an administrator. You can access
+it via http://{{ .instance_url }}.
 
 Your password is: {{ .password }}
 The roles assigned to you: {{ .role }}
diff --git a/server/plugin/plg_authenticate_local/notify.go b/server/plugin/plg_authenticate_local/notify.go
@@ -62,9 +62,10 @@ func withTemplate(in string, user User) string {
 		return in
 	}
 	tmpl.Execute(&b, map[string]string{
-		"user":     user.Email,
-		"password": user.Password,
-		"role":     user.Role,
+		"instance_url": Config.Get("general.host").String(),
+		"user":         user.Email,
+		"password":     user.Password,
+		"role":         user.Role,
 	})
 	return b.String()
 }
diff --git a/server/plugin/plg_backend_git/index.go b/server/plugin/plg_backend_git/index.go
@@ -77,15 +77,15 @@ func (git Git) Init(params map[string]string, app *App) (IBackend, error) {
 		p.commit = "{action} ({filename}): {path}"
 	}
 	if p.authorName == "" {
-		p.authorName = "Filestash"
+		p.authorName = APPNAME
 	}
-	if p.authorEmail == "" {
+	if p.authorEmail == "" && !IsWhiteLabel() {
 		p.authorEmail = "https://filestash.app"
 	}
 	if p.committerName == "" {
-		p.committerName = "Filestash"
+		p.committerName = APPNAME
 	}
-	if p.committerEmail == "" {
+	if p.committerEmail == "" && !IsWhiteLabel() {
 		p.committerEmail = "https://filestash.app"
 	}
 
diff --git a/server/plugin/plg_backend_nfs4/index.go b/server/plugin/plg_backend_nfs4/index.go
@@ -41,7 +41,7 @@ func (this Nfs4Share) Init(params map[string]string, app *App) (IBackend, error)
 		}
 	}
 	if params["machine_name"] == "" {
-		params["machine_name"] = "filestash"
+		params["machine_name"] = APPNAME
 	}
 	if strings.Contains(params["hostname"], ":") == false {
 		params["hostname"] = params["hostname"] + DEFAULT_PORT
diff --git a/server/plugin/plg_search_sqlitefts/indexer/index.go b/server/plugin/plg_search_sqlitefts/indexer/index.go
@@ -85,7 +85,7 @@ func (this *sqliteIndex) Init() error {
 	if queryDB("CREATE TRIGGER IF NOT EXISTS after_file_delete AFTER DELETE ON file BEGIN DELETE FROM file_index WHERE path = old.path; END;"); err != nil {
 		return err
 	}
-	if queryDB("CREATE TRIGGER IF NOT EXISTS after_file_update_path UPDATE OF path ON file BEGIN UPDATE file_index SET path = new.path, filepath = new.filepath, filetype = new.filetype WHERE path = old.path; END;"); err != nil {
+	if queryDB("CREATE TRIGGER IF NOT EXISTS after_file_update_path UPDATE OF path ON file BEGIN UPDATE file_index SET path = new.path, filename = new.filename, filetype = new.filetype WHERE path = old.path; END;"); err != nil {
 		return err
 	}
 	return nil

Original file line number	Diff line number	Diff line change
`@@ -79,8 +79,8 @@ func SaveConfig(v []byte) error {`
`79`	`79`	`file, err := os.Create(config_path())`
`80`	`80`	`if err != nil {`
`81`	`81`	`return fmt.Errorf(`
`82`		`- "Filestash needs to be able to create/edit its own configuration which it can't at the moment. "+`
`83`		- "Change the permission for filestash to create and edit `%s`",
	`82`	`+ APPNAME+" needs to be able to create and edit its configuration, but it currently cannot. "+`
	`83`	+ "Change the permissions to allow writing to `%s`",
`84`	`84`	`config_path(),`
`85`	`85`	`)`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,7 @@ func init() {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`var (`
	`59`	`+ APPNAME string = "Filestash"`
`59`	`60`	`BUILD_REF string`
`60`	`61`	`BUILD_DATE string`
`61`	`62`	`LICENSE string = "agpl"`
`@@ -103,3 +104,7 @@ func env(key string, val string) string {`
`103`	`104`	`}`
`104`	`105`	`return val`
`105`	`106`	`}`
	`107`	`+`
	`108`	`+func IsWhiteLabel() bool {`
	`109`	`+ return APPNAME != "Filestash"`
	`110`	`+}`