Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove all references to Zino *1* #122

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −7
Open

Remove all references to Zino *1* #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
Howitz - Zino web client with HTMx and Flask
============================================

Howitz is an HTTP client interface to Zino, an snmp network monitor.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Johanna suggested this, but it seems it got lost somewhere:

Suggested change
Howitz is an HTTP client interface to Zino, an snmp network monitor.
Howitz is an HTTP client interface to Zino, an SNMP network monitor.


Howitz currently works with the original Zino protocol. Where "Zino server" is
mentioned, we mean a Zino server using the original protocol.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mentioned, we mean a Zino server using the original protocol.
mentioned, we mean a Zino server using the legacy protocol.



Running Howitz step-by-step overview
====================================
Expand Down Expand Up @@ -131,14 +136,14 @@ details.
User management
===============

Due to how Zino protocol 1 does logins, the password (here called token) needs
Due to how Zino protocol does logins, the password (here called token) needs
to be stored in plain text in every client. For security reasons it is not
desirable to ever store this token in a cookie or otherwise in a browser, so
instead the token is stored where the browser cannot get to it, in a user
database local to the frontend server.

When logging in to Howitz a user uses a normal password (not the token) which
is used to safely fetch the token for connecting to the Zino protocol 1 server.
is used to safely fetch the token for connecting to the protocol server.
This password can be treated like any other password and be put in a vault or
a password manager.

Expand Down Expand Up @@ -303,11 +308,11 @@ Example config-file (for development)
For development, copy the contents of the included file ``howitz.toml.example`` to ``.howitz.toml`` in the same directory.

1. Set ``[flask] -> SECRET_KEY`` to some long string.
2. Set ``[zino.connections.default] -> server`` to the address of a Zino 1 server.
3. Optionally set ``[zino.connections.other] -> server`` to the address of a fallback Zino
1 server. If the default server stops working you can swap "other" with
"default" in the config-file and keep on working. If you don't set it to
anything, keep it commented out or remove it.
2. Set ``[zino.connections.default] -> server`` to the address of a Zino server.
3. Optionally set ``[zino.connections.other] -> server`` to the address of
a fallback Zino server. If the default server stops working you can swap
"other" with "default" in the config-file and keep on working. If you don't
set it to anything, keep it commented out or remove it.

As for logging, there is a handler ``debug`` that will copy everything DEBUG or higher to a file
``debug.log``, you might want to use this handler for your code.
Expand Down Expand Up @@ -348,3 +353,7 @@ Future plans

We hope to be able to automatically failover to other servers in
``zino.connections``.

There are plans for an HTTP REST-based protocol in the python-based zino
server. When this protocol is finalized, we plan that howitz will also
Comment on lines +357 to +358
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There are plans for an HTTP REST-based protocol in the python-based zino
server. When this protocol is finalized, we plan that howitz will also
There are plans for an HTTP REST-based protocol in the Python-based Zino
server. When this protocol is finalized, we plan that Howitz will also

understand this new protocol.