This file/page is dedicated completely to go over the various options and ways to configure kitty, all it's options, all it's features and everything alike.
On the command line you can start kitty, and multiple sites with very
little hassle, simply as the command line arguments add the path to a
folder, it'll then host it. To host multiple sites you'll obviously have
to specify the port, as you can't host two sites on the same port, you
can do that by adding :<port> after the path.
Lets say we have a 2 folders, "site" and "site2", we want to host them on port 80, 8080 and 8081 we simply do:
$ kitty site:80 site site2:8081Since it defaults to 8080 not providing one will use 8080, you can also host the same folder on multiple ports.
More command line options will be added soon!
The file locations and or names may be changed in the future, more importantly I'm not sure if the Windows location will stick, as I simply placed it there because I don't understand the file locations for Windows, hence that was just the only place I could think of putting it, make a pull request if there's a better location for it.
The file does not get created by kitty and has to be manually setup.
Linux: /etc/kitty/sites.json
Windows: C:/kitty/sites.json
macOS: /Library/Preferences/kitty/sites.json
An example of the config file is inside the examples/ folder.
sites.json as the name suggests only houses options for sites, it is a
big array with an object (a site) which then has options inside of it.
Default: 8080
This is straight forward, it is simply the port which the site will be
running on, whether it be 8080, 80, or a completely different port.
Generally you can only use a port above 0, and below 65536, however this
is a restriction by the OS itself (from what I know) and could change.
You also can't use anything below or equal to 1024 without root/admin
permissions, again a restriction by the OS.
Setting the port to 0 will set it back to it's defaults (8080),
however there's nothing stopping you from setting it to a number that's
not below 65536, however your OS may not like it.
Default: "Untitled Site"
This setting is what's printed when mutliple sites are started to make it easier to identify each individual site more clearly, it is also planned to be used for more than just that in the future.
Default: ""
Again very straight forward, the path for the site, if a path that
doens't exist is provided it'll error out. By if no path is set it'll
default to an empty string, which in turn becomes root (/).
Default: []
authentication enabled basic authentication through the htpasswd
option, it takes in an array of regEx strings which if matched against
the requested URL will ask for authentication.
Default: ""
When a valid path is provided and it's enabled it'll prompt the user to enter credentials when accessing the site. It's up to the browser how long it'll save the login, and I don't know of any way I can prolong or edit it, not even tell the browser to listen to my recommendation of how long it should stay logged in.
Default: "Login to view"
Used in conjuction with authentication and htpasswd, it changes the
message displayed in the login prompt. Setting it to nothing resets it
to the default, so if you want an empty message set it to: " "
Default: []
This takes either an array or boolean, if set to true it'll disable
all file listings and give a 404 error instead, if set to false it'll
do nothing and show the file listings. If set to an array, when
accessing a page it'll check if the path is matched with a regEx
pattern, that is, the array houses regEx patterns and when matched it'll
disable file listings.
Default: []
This takes an array of strings or a singular string, that string will be matched with regEx against the files or directories in the file listings if it matches it'll allow it to be showed in the file listings. Otherwise it'll hide it.
This means a value of .*\.html will only ever allow .html files to
be shown in the file listings.
Default: []
Very much the opposite of show_files it'll take an array of strings or
a single string it'll then use regEx to match it against files and
directories in the file listings, if it matches it'll hide that file,
compared to show_files which allows it to be visible instead.
This means a value of .*\.php will stop .php files from ever
appearing in the file listings.
Default: []
This option takes in an array of regEx strings and then matches it against the requested path, if it matches it'll allow you to view/GET the file.
This means a value of [".*\.html"] will only ever allow you to request
HTML files, which is obviously a bad idea if you've any CSS files or
alike.
This option acts like a whitelist for files.
Default: []
This option is much the opposite of allow_files, it also takes in an
array of regEx strings, then matches it against the requested URL.
This means a value of [".*\.js"] will stop you from ever requesting a
JavaScript file. If of course it is suffixed with .js
This option acts like a blacklist for files.
Default: []
This option takes in an array of regEx strings and then matches it
against the requested path, if it matches it'll turn off the default
HTML+CSS error page, this means it'll let the browser do whatever it
wants when it gets a 404.
This means if you want to turn of the error page completely and let the
browser always show it's own thing, simply have it set to [".*"]
This is the config every site has by default, if you apply any settings to your site they'll overwrite whatever is in here. If you don't configure one of the variables it'll use the defaults here.
{
"port": 80,
"path": "",
"site": "Untitled Site",
"htpasswd": "",
"authentication": [],
"auth_msg": "Login to view",
"show_files": [],
"hide_files": [],
"allow_files": [],
"block_files": [],
"no_errorpage": [],
"no_filelistings": []
}