Skip to content
This repository has been archived by the owner on Oct 21, 2024. It is now read-only.

Latest commit

 

History

History
77 lines (52 loc) · 1.71 KB

README.md

File metadata and controls

77 lines (52 loc) · 1.71 KB
Raw

Cinnabar Forge SnapServe

Web-serve your folders in a snap using various view modes

TODO

Getting Started

Installation

Install SnapServe globally using npm:

npm install -g snapserve

To access global plugins (snapserve-*), use export NODE_PATH=$(npm root -g). To make the NODE_PATH setting permanent for Node.js, you can add it to your user's profile configuration file. This file is typically ~/.bash_profile, ~/.bashrc, ~/.profile, or ~/.zshrc, depending on which shell you are using.

Configuration

File ~/.config/cinnabar-forge/snapserve/users.json contains login-password pairs for Basic Authorization

Usage

Serve current directory:

snapserve

Serve current directory at port 42069:

snapserve -p 42069

Serve directory /home/user/nice:

snapserve -f /home/user/nice

Serve current directory with disabled Basic Authorization:

snapserve --noAuth

Serve current directory with built-in gallery mode:

snapserve -m gallery

Serve current directory with snapserve-wonka npm package:

snapserve -m npm-wonka

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request.

Clone the repository and install dependencies:

git clone [email protected]:cinnabar-forge/snapserve.git
cd snapserve
npm ci

You can also develop a plugin! See snapserve-wonka as example to start.

License

Cinnabar Forge SnapServe is licensed under the ISC License - see the LICENSE file for details.

Authors