Project

General

Profile

Feature #55

[Roadmap 2][Milestone] Write documentation for Hydrilla

Added by koszko 10 months ago. Updated 22 days ago.

Status:
Closed
Priority:
High
Assignee:
Start date:
07/22/2021
Due date:
% Done:

100%

Estimated time:

Description

We need to document current workings, as well as planned future mechanisms of Hydrilla. The best place for this is going to be the Wiki here.

Things that need documenting and come to my mind:

  • codebase description, what does what and how do things interact - docstrings currently present in the new Hydrilla sources should suffice
  • data format description - how site resources are stored in the filesystem (the other side - data format for network communication - is already being worked on1)
  • how to run Hydrilla
  • a sample Apache (later also Nginx) config as Hydrilla is meant to sit behind a reverse proxy be run through a WSGI script
  • a sample WSGI script for Hydrilla
  • manpages for hydrilla and hydrilla-builder2

This will be needed for Hydrilla 1.0. The 1.0-beta1 pre-release can be made without such thorough documentation

Roadmap


Related issues

Blocks Haketilo - Feature #104: [Roadmap 2] Haketilo and Hydrilla 1.0 releaseClosed02/23/2022

Actions

Associated revisions

Revision 363cbbb6 (diff)
Added by koszko 3 months ago

add Hydrilla builder manpage

Revision 1cb6aaae (diff)
Added by koszko 3 months ago

add Hydrilla server manpage

History

#1

Updated by koszko 10 months ago

This is the apache2 config I am using right now:

<VirtualHost *:80>
  ServerName hydrilla.koszko.org

  Redirect permanent / https://hydrilla.koszko.org/

  ErrorLog ${APACHE_LOG_DIR}/error.log
  CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

<IfModule mod_ssl.c>
  <VirtualHost _default_:443>
    ServerName hydrilla.koszko.org
    ServerAdmin koszko@koszko.org

    DocumentRoot /var/lib/hydrilla/

    <Directory /var/lib/hydrilla/>
        Require all granted
    </Directory>

    ProxyPass /content/ !
    ProxyPass "/"  "http://localhost:10111/"
    ProxyPassReverse "/"  "http://localhost:10111/"

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

    SSLEngine on
    SSLCertificateFile          /some/path/cert.pem
    SSLCertificateKeyFile       /some/path/privkey.pem
    SSLCertificateChainFile     /some/path/chain.pem
  </VirtualHost>
</IfModule>
#2

Updated by koszko 3 months ago

  • Description updated (diff)
  • % Done changed from 0 to 80
#3

Updated by koszko 3 months ago

  • Description updated (diff)
#4

Updated by koszko 3 months ago

  • Blocks Feature #103: [Roadmap 1] Haketilo and Hydrilla 1.0 pre-release added
#5

Updated by koszko 3 months ago

  • Blocks deleted (Feature #103: [Roadmap 1] Haketilo and Hydrilla 1.0 pre-release)
#6

Updated by koszko 3 months ago

  • Blocks Feature #104: [Roadmap 2] Haketilo and Hydrilla 1.0 release added
#7

Updated by koszko 3 months ago

  • Description updated (diff)
#8

Updated by koszko 3 months ago

  • Status changed from New to In Progress
  • Assignee set to koszko
#9

Updated by koszko 3 months ago

  • Subject changed from Write documentation for Hydrilla to [Roadmap 2][Milestone] Write documentation for Hydrilla
#10

Updated by koszko 3 months ago

  • Description updated (diff)
#11

Updated by koszko 3 months ago

  • Description updated (diff)
  • Assignee changed from koszko to 0gitnick

What do you think about the new manpages, Nick?

Also, I believe it would be beneficial to have you prepare and add the missing Apache config and WSGI script based on what I sent you in one of the emails. This way we will know it is also approachable by people other that the author of the package :)

reference:
https://flask.palletsprojects.com/en/2.0.x/deploying/mod_wsgi/

#12

Updated by koszko 22 days ago

  • Status changed from In Progress to Closed
  • Assignee changed from 0gitnick to koszko
  • % Done changed from 80 to 100

Also available in: Atom PDF