swizzler/README.md at d959492b2b6882c2b5997f76cafeb1bf4ff36ad6

mirror of https://github.com/twisterarmy/swizzler.git synced 2025-03-12 13:31:26 +00:00

The Dod d959492b2b Basic auth (existing instannces: read commit text)

First, chill:
After you pull this, your current installation is supposed to
work fine *as is* (please let me know if it doesn't).

Nevertheless, it is recommended to enable basic auth by adding
these 2 lines to the `[swizzler]` section of `cherrypy.config`
(also documented at `cherrypy.config.example`)

    browser_user: 'someuser'
    browser_password: 'somepassword'

User and password don't need to be too long and funky
(or have anything to do with the user:pasword at rpc_url).
It's just a line of defense against [for example] trojans
who may not have significant file system rights,
but can still TCP-connect to localhost ;)

Existng apps should also `chmod 600 cherrypy.config`
(running `/.install.sh` again will do this as well),
because it would now contain a plaintext password
(and we don't want trojans yada yada).

Swizzle safely.

2014-04-01 19:33:13 +07:00

2.2 KiB

Raw Blame History

Goals

Provide a twister web client that:

is #NoJS^TM - currently, it has no JS at all, which is a trivial case ;), but all pull-request should work when JS is disabled. That's the only "rule".
Is simple enough for people to fork and try other front-ends or features (I have a few in mind. I'm sure you have others).

In short: it's a "twister-client constructor kit". Even if what you do doesn't get merged upstream, who says we should all run the same client? Diversity is fun.

Roadmap

The following functionality is missing before Swizzler becomes a full read-only version

Direct messages - currently, there are links to that (look like an envelope) but they're 404 ;)
Search box - for hashtags and users by prefix
Basic auth - we don't want trojans to read our direct messages, so I guess this is top priority ;)

I believe this should take a few days.

Future

To be defined
Then we take Berlin

Dependencies

You also need tweaked versios of python-bitcoinrpc and functioncache but these are defined as git submodules, so install.sh takes care of them.

To install

Install dependencies mentioned above
Run ./install.sh to create cherrypy.config and appdir.py
Edit cherrypy.config (at least edit the user:pwd@ at rpc_url, but it's also recommended to uncomment and edit the browser_user and browser_password lines to enable basic authentication before someone develops a swizzler-specific trojan ;) )

To run

python swizzler.py
It should say ENGINE Serving on 127.0.0.1:7919 (or whatever host and port you've defined at cherrypy.conf)
Browse to that address

2.2 KiB Raw Blame History