https://github.com/iammoltony/jshs

Simple home server in JavaScript
https://github.com/iammoltony/jshs

express file-server home-server javascript nodejs

Last synced: 23 days ago
JSON representation

Simple home server in JavaScript

• Host: GitHub
• URL: https://github.com/iammoltony/jshs
• Owner: IAmMoltony
• License: mit
• Created: 2024-01-22T09:47:06.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-08T04:29:54.000Z (12 months ago)
• Last Synced: 2024-11-14T21:12:27.284Z (3 months ago)
• Topics: express, file-server, home-server, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 563 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# jshs

jshs is a simple home server written in Node.js and powered by Express.

## Installation

1. Make sure you have node.js installed

1. Clone the repo: `git clone https://github.com/IAmMoltony/jshs`

1. In the repo folder, run `npm i`

1. Now generate a password: `node gen-password.js `

  - Note: this can be skipped if you disable authentication

    in `jshs-config.json` but this is **VERY HIGHLY DISCOURAGED**.

    Please do not disable auth unless that is completely

    necessary.

1. Done

Now to start jshs, run `node index.js`. The default port is

8000, but it can be changed on the config.

## Configuration

Configuration is done using the `jshs-config.js` file.

- `uploadsFolder`: Folder where uploads will be stored

- `fileRoot`: Root of all files. If using an absolute path for `uploadsFolder`,

  set this to `/`. If the uploads folder is relative to the jshs root directory,

  then set to `*DIRNAME*`.

- `port`: The port on which the server will run. 8000 is usually fine.

## Features

- Web-based interface

- Streaming uploaded video and audio

- Basic file manager

- Mobile-friendly (mostly)

- Authentication with a password