Seraph

Ichinoe

Introduction

Seraph is a cloud server assistant aiming to make advantage of hosts' potential.

Usage

1. Install Node.js no earlier than v16.7.0 (on which fs.cpSync was added) and npm.js

2. Clone this repository to your cloud server and install dependencies in package.json

   git clone https://github.com/ShiinaHiiragi/seraph
   cd seraph/
   npm install
   cd server/
   npm install

3. IMPORTANT: Create an .env file under seraph/

   • on Linux: touch .env for Bash
   • on Windows: type nul >.env for CMD or New-Item .env for Powershell

   OPEN .env AND ADD FOLLOWING CONFIGURATION:

   • development (npm run dev) with react on 80 and express on 8000:

     REACT_APP_PROTOCOL=http
     REACT_APP_HOSTNAME=localhost
     REACT_APP_PORT=80
     REACT_APP_SPORT=8000

   • deployment (npm start) with express on 443 (DO NOT DEFINE REACT_APP_PORT):

     REACT_APP_PROTOCOL=https
     REACT_APP_HOSTNAME=${YOUR_HOSTNAME}
     REACT_APP_SPORT=443

     and certificate ${HOSTNAME}.crt and key ${HOSTNAME}.key MUST be added under seraph/server/cert

   • deployment (npm start) with nginx proxy from 443 to express on 8000:

     REACT_APP_PROTOCOL=http
     REACT_APP_HOSTNAME=${YOUR_HOSTNAME}
     REACT_APP_PORT=443
     REACT_APP_SPORT=8000

     and configure your nginx config (located at /etc/nginx/sites-available/default) with sudo nginx -t && sudo systemctl reload nginx

     server {
         listen 443 ssl;
         server_name ${YOUR_HOSTNAME};
     
         ssl_certificate     /etc/nginx/ssl/${YOUR_HOSTNAME}_bundle.crt;
         ssl_certificate_key /etc/nginx/ssl/${YOUR_HOSTNAME}.key;
     
         location / {
             proxy_pass http://localhost:8000;
             proxy_set_header Host $host;
             proxy_set_header X-Real-IP $remote_addr;
         }
     }
     

     a reload is needed after updation of certificates

4. Start the server (make sure .env is created before executing following command)

   npm run build
   # tmux new -t seraph
   npm start
   # detach from session via Ctrl+B D

   stop this process using Ctrl+C; or just use tmux new -d -s seraph 'npm start'

   tmux attach -t seraph
   tmux kill-session -t seraph

   • for Linux user who receive error like 'Port 80 requires elevated privileges', try running

     sudo setcap 'cap_net_bind_service=+ep' $(which node)

   • for Linux usesr who receive error like 'sudo: node: command not found', add path of node to visudo

     sudo visudo

   • for those who receive error like 'Can't resolve @mui/material/utils', try running the following command

     npm install @mui/material @emotion/react @emotion/styled

5. Open page and initialize configuration via setting language and password

Log

• 2023 10/17 ver 0.2.1 Fix several bugs and add extraction
• 2023 10/16 ver 0.2.0 Add TODO list
• 2023 9/19 ver 0.1.1: Fix several bugs
• 2023 9/18 ver 0.1.0: Complete folder page

TODO

• hide dot files
• hash tag problem
• shortcut supports
• auto delete cron
• setting popup

Memo

1. File Explorer
   • edit in milkdown
   • create / edit attached markdown
2. Milkdown
   • edit / read only
   • save in folder / attach to file
   • download
3. Subscription: receive message from
   • cron(cron)'s & sync(ntp-time-sync)'s snippet
   • local mail sever
   • listening server
4. Terminal
   • open powershell / bash
   • terminal: react-terminal