-
Notifications
You must be signed in to change notification settings - Fork 296
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.
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
doc: rework installation/setup guides, general refactoring #1389
Conversation
Still work in progress, see:
As you can see this PR also proposes dropping support for the
In short the |
In I'm running Arch Linux and have only had my webserver for a few months. If it works for you, feel free to ignore. |
I will definitely re-test all setup procedures before removing the work-in-progress status. Apache 2.4 will be used for the test. <Directory> should work inside a virtualhost definition but I will double-check everything, thanks |
Rebased, squashed.
I still have to test some procedures and change ordering (for example I know the setup procedure still takes you back and forth between 2 pages), but the bulk of it is done. Let me know what you think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Impressive work!
I did not reread everything as it's quite hard to follow the moved part, but the result you linked looks great to me.
I solved my NAT problems which were preventing me from testing install procedures with proper Let's Encrypt certificate generation. I will do another pass this weekend and probably include some asccinema demos of the process. |
…s Encrypt certificates
see https://github.com/nodiscc/xsrv/blob/master/roles/apache/templates/etc_apache2_conf-available_logging.conf.j2 for an example server-wide logging configuration
…edure (asciinema)
…on, move reference links to their respective sections, shorten
…y virtualhost (only used for redirects)
Besides adding 2 new plugins, also reordered the list by ABC and fixed some discrepancies in the details to restore balance in the force
eafa5d2
to
97870f3
Compare
rebased. |
A full and concise installation guide with examples is a frequent request.
The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end of teh document.
Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration.
Ideally the download, installation, server setup and security sections should fit on a single page.
Another page can walk the user through installing Shaarli in Docker behind a reverse proxy.