diff --git a/README.md b/README.md index 8e6a5a4..67d2af7 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,46 @@ Select the port and click "listen to port" to start the service. Remote connections will be allowed. Add a path to share and you can open this path using the computer IP. +The root menu is a small directory of available services, can be disabled, but no service can be used as root. + +### Editor + |![](doc/editor.png)| |:--:| | Editor screen | +**Type:** +Type of service, Version 2.0 only have the standard WebService but it can be added throught plugins or next versions. +**Name:** +Name of the service, only for display, and for the root menu. + +**Location:** +Location of the service in the web path. + +**Directory:** +The filesystem directory to expose + +**Default document:** +The default index docuent. + +**Folder Share:** +Allow folder share (directory frontend), if disabled the behaviour is similar to a web share. + +**Read only:** +The shared is read only (no modifications allowed), if disabled the upload and rename of files is enabled. + +**Allow delete:** +The files can be deleted, requires non read only configuration. + +**Allow execute:** +Execute the file on the server side (See warinigs). + +### Plugin development + +See [Plugin development](doc/plugins.md) file + +### Notes A list o available computer IPs are show on the About... button (near the OK) diff --git a/Sunfish/Services/WebServiceConfigurator.cs b/Sunfish/Services/WebServiceConfigurator.cs index 3433734..f4f02be 100644 --- a/Sunfish/Services/WebServiceConfigurator.cs +++ b/Sunfish/Services/WebServiceConfigurator.cs @@ -35,7 +35,7 @@ Tooltip = "Default document for directory path", DefaultValue = "index.html" }, - new ConfigurationBool(CFG_SHARE,"Folder share (Web && DAV)") + new ConfigurationBool(CFG_SHARE,"Folder share")// (Web && DAV)") { Tooltip = "Allow directory listings, switched off the server will report a forbidden message if the directory has no default file. Also enables DAV protocol", DefaultValue = true, @@ -53,7 +53,7 @@ { Tooltip = "Allow application execution on server." }, - new ConfigurationMessage(ConfigurationMessage.MessageType.WARNING,"WARNING: Sunfish is executed as elevated process, any anction or process started by sunfish will be also elevated.") + new ConfigurationMessage(ConfigurationMessage.MessageType.WARNING,"WARNING: Sunfish is executed as elevated process, any action or process started by sunfish will be also elevated.") }, //Advanced = AdvancedEditing }; diff --git a/doc/editor.png b/doc/editor.png index afdb4d2..e982c1b 100644 --- a/doc/editor.png +++ b/doc/editor.png Binary files differ diff --git a/doc/plugins.md b/doc/plugins.md new file mode 100644 index 0000000..1b6103e --- /dev/null +++ b/doc/plugins.md @@ -0,0 +1,5 @@ +Sunfish allow plugin creation too add more functionality through service types. + +# Create new plugin + +Create a new C# library project and use Sunfish.exe as reference. \ No newline at end of file