Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 2.63 KB

README.md

File metadata and controls

46 lines (35 loc) · 2.63 KB
Raw

algia-web

algia CLI command backed server-side rendering Nostr web client

  • algia is a tool and very simple client for using micro blog application with Nostr protocol developed by mattn

Difference with other clients

  • Handling of Nostr protocol is done by your machine running server program of algia-web
    • algia is simple Nostr client which can run on CLI environment
    • At a point of view, algia-web is a kind of wrapper client of the client running on the machine (=algia)
  • This architecture can save communication amount and battery consumption of your smartphone and other mobile devices you use Nostr with Web browser at
  • Your web browser only renders contents received from the server
    • Almost all of clients for mobile devices handle messages received from relay server by myself. But the job consumes not small amount of computation and network resources
    • Above job is ofen not acceptable for some people who use mobile devices out of doors
  • does not offers rich UI/UX and support many features as Nostr client
  • is developed in assumption that it is not used as main client and is used when you do not have power supply or connect to The internet via mobile network which has restriction of total communication amount

Requirements

  • A machine which can be accessible from your device
    • Mostly the machine must have global IP address

Needed steps to use algia-web client

  • Setup of algia and executing server program of algia-web at your machine mentioned above
    • Includes making 8080 port (default) accecible from The internet
  • Procedure
    1. Setup algia for your Nostr account
    2. Setup python environment
    3. Setup algia-web server
      1. $ git clone https://github.com/ryogrid/algia-web.git
      2. $ cd algia-web
      3. $ pip install -r requirements.txt
      4. $ python algia-serv.py
        • bind port is 8080 (default). if you want change port, you should edit last line of algia-serv.py
      5. Make the server program accecible from the Internet
        • In many cases, you should configure firewall software on your machine (iptables, firewalld ... etc)
    4. Access http://[global address of your server machine]:8080/

Usage detail

Screen capture (on Smartphone)