https://github.com/yuri2peter/remote-sh

Provides a friendly way for managing your shell scripts on your server. you can add, edit, remove, run your scripts easily.
https://github.com/yuri2peter/remote-sh

Last synced: about 2 months ago
JSON representation

Provides a friendly way for managing your shell scripts on your server. you can add, edit, remove, run your scripts easily.

• Host: GitHub
• URL: https://github.com/yuri2peter/remote-sh
• Owner: yuri2peter
• Created: 2020-04-29T07:51:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-31T01:02:12.000Z (over 2 years ago)
• Last Synced: 2024-04-16T14:08:18.219Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 988 KB
• Stars: 34
• Watchers: 3
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# remote-sh

[中文文档](./README_zh_cn.md) |

English Documents

Managing & runing your shell scripts on web!

`remote-sh` provides a friendly way for managing your shell scripts on your server. you can add, edit, remove, run your scripts easily.

Each script can be triggered by a UNIQUE URL so you can use it anywhere like:

```

$ curl https://YOUR_REMOTE_SH_HOST/script/run/example.sh/UNIQUE_SIGN_FOR_THIS_SCRIPT

```

The system use Access Key policy to identify yourself.

![img1](./assets/img1.png)

![img2](./assets/img2.png)

![img3](./assets/img3.png)

## Install

```

$ npm ci

```

## Deploy

All you need is keeping this running:

```

$ npm start

```

### Port

Set port at file `./configs.js` ( default: 3020 ).

### HTTPS

We strongly recommend that enabling the HTTPS feature.

To start your web server with HTTPS, you must set `useHttps: true` and `port: 443` at file `./configs.js`, then copy your certificate files to `./https/server.key` and `./https/server.crt`.

You can also use other ways for HTTPS ( for me, i'd like to try [steveltn/https-portal](https://hub.docker.com/r/steveltn/https-portal/) ).

### Background Running

`pm2, screen, docker` will help you doing that.

```bash

pm2 start pm2.json

pm2 save

pm2 startup

```