rwnx / piku-dashboard Goto Github PK

A dashboard for piku, as a piku app!

License: MIT License

Python 37.98% HTML 22.77% CSS 39.20% Procfile 0.06%

piku-dashboard's Introduction

Piku Dashboard

Piku dashboard is a management interface for apps running in piku. It is itself an application that runs inside of piku (so meta!).

Piku dashboard handles most runtime viewing and management concerns:

Viewing Host information
Viewing Logs
Viewing and managing Config values
Managing Application lifecycle (Starting, Stopping, Restarting)
(WIP) Managing worker scaling
Destroying applications

Piku Dashboard tries to delegate to the ~/piku.py script whereever possible, to avoid re-implementing behaviour present in the original script (and subsequently create hidden dependencies.).

Structurally, it is a python/flask web app with basic authentication.

Quick start

pull this repo, and deploy to your piku instance using git:

git remote add piku [email protected]:piku_dashboard
git push piku master

Set config keys for session management and basic authentication:

# shown here using the piku operator helper
piku config:set SECRET_KEY=abcdef123456790 USERNAME=bob PASSWORD=asdfghjkl0

# You can set other settings, like port number, etc, as you would with any piku app

Navigate to the hosted piku_dashboard and start managing your apps. The default port is listed in the ENV file.

piku-dashboard's People

Contributors

Stargazers

Watchers

Forkers

matrixjnr corvimia

piku-dashboard's Issues

Add User Management

piku-dashboard should start with a default admin/password configuration
should be able to view, create, update and delete users to grant access to the platform
a use with config/push rights should be able to reset the password state of the dashboard (i.e. by changing a config setting)
admin should be prompted to reset password on first login

Technicals

without a database, data could be serialized and stored in piku-dashboard's config variables
passwords should be stored hashed

Add Worker scaling management

the piku cli can manage the number of uwsgi workers with the ps:scale command.

you should be able to control this from the dashboard for each application.

See https://github.com/piku/piku for more info.

Detect dashboard app name

detect the dashboard app name by looking at the app directory, and remove the requirement to specify this in the environment.

New Version Link is displayed when app is already up-to-date

The new version detection introduced in #34 is showing up when the app is already up to date.

Below: a screenshot of the piku_dashboard app at the current commit, and following the link through shows the same commit sha.

Technical stuff:

I think this is because short git commit SHAs are actually 7 characters, not 6, like we slice them here
I think we should avoid this entirely by returning the entire SHA from get_github_sha and use a startswith match in the template.

Visually hide configs by default

At the moment the config page just displays the form values in plaintext.

Ideally, these values should require pressing a button to reveal.

Add normal login form instead of http basic prompt

Use an actual login prompt with html and styling!

it's prettier
it's better for browsers remembering passwords etc

Hash password env

It would be nice if the password environment config (or however we're storing it) wasn't just the password in plaintext.

Prepare project for collaboration

To prep this project for contribution:

Add github issue templates
- e.g. https://github.com/rwnx/pynonymizer/blob/master/.github/ISSUE_TEMPLATE/bug_report.md
Add CONTRIBUTING.md
- Include info on code style and linting
  See example https://github.com/rwnx/pynonymizer/blob/master/CONTRIBUTING.md

Keep it lightweight but informative!

Allow adding new configs

You can view and edit existing ones but you can't add a new one

Add version readout

add a version to the app in a __version__ var
display this somewhere in the app

Add confirm to "destroy" button

It's scary! it's irreversable! it should prompt you!

Add per-app version/commit hash readout

Investigate and add latest hash info from the git repos for each app.

Also: investigate showing git history?

Improve error handling

When a fatal error occurs, page returns a generic 500 error
It could display more information about the error
It could display logs from the self_app

Add Test/Lint to PR CI/CD

Add linting (see #24) checker to a github workflow that runs on PR
Add test runner (if there are any)

Thanks for making this!

First, sorry for writing an issue about this. But I figured that it would be easiest way to get in touch with you and knowing that code you wrote is being used is a great feeling.

I use this since 5 months and it is really great! I share my server with friends and this gives them easy access to logs and restarts etc. It has been really great so far and thanks for building this.

Add Linting

Establish a canonical formattings style and linter (Black?)
capture version (some format like dev-requirements.txt: do not put this in the main requirements.txt otherwise piku will install it on deploy)
Add documentation for running the linter
Run the linter on the project (and commit the result)