Skip to content

swshtaccess documentation #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ethanaobrien wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

swshtaccess documentation #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 36 additions & 26 deletions website/src/docs/swsaccess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,42 @@

Simple Web Server does not have support for .htaccess files. Instead, we support custom .swshtaccess files, which offer a subset of the features of .htaccess files.

:::warning
This functionality is experimental and may change in future releases. Consider using [plugins](/docs/plugins.md) instead.
:::

## How to

All Htaccess features are built to have 100% compatibility with changes in settings


## Currently supported
301 - Moved Permanently. Tells the server that when chosen file is requested to move to a different directory or file. The browser will cache this<br>
302 - Found. Tells the server that when chosen file is requested to move to a different directory or file. Not cached by the browser<br>
307 - Temporary Redirect. Tells the server that when chosen file is requested to move to a different directory or file. Not cached by the browser.<br>
401 - Unauthorized. The page will require login. For some reason, I cannot find how to clear the cache of the authorization header, which means that once you type it in, the browser will not ask for a login, unless you have multiple password protected pages with different passwords, The <br>authentication header will change whenever you enter a different password.
403 - blocks any request to the file<br>
denyDirectAccess - This will deny direct access to image/video/audio files. This option only works if https is enabled or if the user is on a localhost address.<br>
Render Directory Listing - Ignores the value of 404 instead of directory listing and renders the directory listing<br>
Deny deleting for a specific file or directory - Ignores value of delete option and will deny delete to requested file<br>
Allow deleting for certain file - Ignores value of delete option and will allow deleting requested file<br>
Deny uploading for a specific file or directory - Ignores value of PUT option and will deny put to requested file<br>
Allow uploading for certain file - Ignores value of PUT option and will allow deleting requested file.<br>
send directory contents - Will send the current directory at the end of the file. See the How To for a more advanced description<br>
additional header - Will set an additional header<br>
Versioning - relative file hosting<br>
serverSideJavaScript - Just what it sounds like<br>
**301 - Moved Permanently**: Tells the server that when chosen file is requested to move to a different directory or file. The browser will cache this<br>

**302 - Found**: Tells the server that when chosen file is requested to move to a different directory or file. Not cached by the browser<br>

**307 - Temporary Redirect**: Tells the server that when chosen file is requested to move to a different directory or file. Not cached by the browser.<br>

**401 - Unauthorized**: The page will require login. For some reason, I cannot find how to clear the cache of the authorization header, which means that once you type it in, the browser will not ask for a login, unless you have multiple password protected pages with different passwords, The <br>authentication header will change whenever you enter a different password.

**403**: blocks any request to the file<br>

**denyDirectAccess**: This will deny direct access to image/video/audio files. This option only works if https is enabled or if the user is on a localhost address.<br>

**directory listing**: Ignores the value of 404 instead of directory listing and renders the directory listing<br>

**deny delete**: Ignores value of delete option and will deny delete to requested file<br>

**allow delete**: Ignores value of delete option and will allow deleting requested file<br>

**deny upload**: Ignores value of PUT option and will deny put to requested file<br>

**allow upload**: Ignores value of PUT option and will allow deleting requested file.<br>

**send directory contents**: Will send the current directory at the end of the file. See the How To for a more advanced description<br>

**additional header**: Will set an additional header<br>

**versioning**: Relative file hosting based on url arguments<br>

**serverSideJavaScript**: Custom, server side, javascript scripts<br>

If you want more features - Make an issue!

## Making the file
Expand Down Expand Up @@ -265,9 +278,9 @@ Example:
```
More howto (send directory contents)

This feature CANNOT use the `all files` value for the `request_path` field. You must specify each file separately
if dir_to_send is not specified, then the current directory will be sent
Getting info from sent contents
if `dir_to_send` is not specified, then the current directory will be sent

#### Getting info from sent contents
This is what is sent

```
Expand Down Expand Up @@ -299,7 +312,7 @@ Example:
}
]
```
Please refer to the <a href='custom scripts.md'>custom scripts readme</a> To learn how to respond.
Please refer to the <a href='custom scripts.html'>custom scripts readme</a> To learn how to respond.

The only difference is - DO NOT declare the type as postKey in the htaccess file and instead of using `postKey = 'wa4e76yhefy54t4a'` use `SSJSKey = 'wa4e76yhefy54t4a'`

Expand Down Expand Up @@ -332,6 +345,3 @@ For the last ruleset, no comma can be after the `}`. This will break the array a
When using multiple rulesets per file, the server will first check if an authentication rule is in place. If it is, the server will require the user to enter the password before it will allow the user to do anything. After the user has correct auth (if the auth is present) it will check for rulesets from the top of the file, to the bottom. The redirects, the directory listing, and sending the current directory with the file cannot both be used, whatever the web server picks up first is what will be executed.

You can have as many additional headers as you like!