Feature #55
[Roadmap 2][Milestone] Write documentation for Hydrilla
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 sufficedata 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 proxybe run through a WSGI script - a sample WSGI script for Hydrilla
manpages for2hydrillaandhydrilla-builder
This will be needed for Hydrilla 1.0. The 1.0-beta1 pre-release can be made without such thorough documentation
Related issues
History
Updated by koszko about 2 years 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>
Updated by koszko over 1 year ago
- Blocks Feature #103: [Roadmap 1] Haketilo and Hydrilla 1.0 pre-release added
Updated by koszko over 1 year ago
- Blocks deleted (Feature #103: [Roadmap 1] Haketilo and Hydrilla 1.0 pre-release)
Updated by koszko over 1 year ago
- Blocks Feature #104: [Roadmap 2] Haketilo and Hydrilla 1.0 release added
Updated by koszko over 1 year ago
- Subject changed from Write documentation for Hydrilla to [Roadmap 2][Milestone] Write documentation for Hydrilla
Updated by koszko over 1 year 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/
Updated by koszko over 1 year ago
- Status changed from In Progress to Closed
- Assignee changed from 0gitnick to koszko
- % Done changed from 80 to 100
add Hydrilla builder manpage