Differences between revisions 26 and 27
Revision 26 as of 2016-11-19 00:30:41
Size: 1931
Editor: TheAnarcat
Comment: move main website to rtfd
Revision 27 as of 2016-12-04 23:32:24
Size: 2526
Comment: Update status
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
The current `manpages.debian.org` service has been disabled by [[Teams/DSA]] because of performance issues. The source code is available in http://anonscm.debian.org/viewvc/ddp/man-cgi/ and was supposed to be migrated to a different host. The current `manpages.debian.org` service is a simple Perl CGI script running on manziarly.debian.org. This script searches within an archive that is generated through another set of scripts. The source code is available in http://anonscm.debian.org/viewvc/ddp/man-cgi/

In the past (when running in glinka.debian.org) this service was disabled by [[Teams/DSA]] several times because of performance issues. Even though the service has been modified to improve caching (on memory and on disk) it still was getting hit hard by robots that request Apache manpages. This excessive traffic is generated as many default Apache installations in Debian include links to these manpages (see http://bugs.debian.org/821313).

The last time it was disabled was in August 2016, and remain in that state until it was re-activated in December 2016.
Line 15: Line 19:
The current codebase is being rewritten from scratch into a package called [[https://debmans.readthedocs.io/en/latest/|Debmans]] See the [[https://debmans.readthedocs.io/en/latest/design.html|design document]] for a discussion on the implementation. The current codebase is being rewritten from scratch by TheAnarcat into a package called [[https://debmans.readthedocs.io/en/latest/|Debmans]]. See the [[https://debmans.readthedocs.io/en/latest/design.html|design document]] for a discussion on the implementation.
Line 17: Line 21:
At this point, the code can extract all files from a mirror efficiently and convert them to HTML. It has not been tested on a full mirror yet, because TheAnarcat is waiting for `manpages` group access and dependencies install (`setuptools` from backports and/or `python-click`, `python-apt` and `python-debian`). See the [[https://debmans.readthedocs.io/en/latest/todo.html|TODO]] file for more information about the current status of the project and limitations. At this point, the debmans code can extract all files from a mirror efficiently and convert them to HTML. It has not been tested on a full mirror yet, because TheAnarcat is waiting for `manpages` group access and dependencies install (`setuptools` from backports and/or `python-click`, `python-apt` and `python-debian`) in manzarly. See the [[https://debmans.readthedocs.io/en/latest/todo.html|TODO]] file for more information about the current status of the project and limitations.
Line 23: Line 27:
The old service used to run on `glinka.debian.org`. [[Teams/DSA]] requested the service should be moved to `manziarly.debian.org`. The service is running in `manziarly.debian.org`. It used to run on `glinka.debian.org`.
Line 29: Line 33:
You can also subscribe to this wiki page to get updates, which also functions as a ad-hoc forum. You can also subscribe to this wiki page to get updates, which also functions as an ad-hoc forum.

https://manpages.debian.org/ is a service providing online manpages in HTML format for the public.

Current status

Debian manpages archive

Current implementation

The current manpages.debian.org service is a simple Perl CGI script running on manziarly.debian.org. This script searches within an archive that is generated through another set of scripts. The source code is available in http://anonscm.debian.org/viewvc/ddp/man-cgi/

In the past (when running in glinka.debian.org) this service was disabled by Teams/DSA several times because of performance issues. Even though the service has been modified to improve caching (on memory and on disk) it still was getting hit hard by robots that request Apache manpages. This excessive traffic is generated as many default Apache installations in Debian include links to these manpages (see http://bugs.debian.org/821313).

The last time it was disabled was in August 2016, and remain in that state until it was re-activated in December 2016.

New implementation

The current codebase is being rewritten from scratch by TheAnarcat into a package called Debmans. See the design document for a discussion on the implementation.

At this point, the debmans code can extract all files from a mirror efficiently and convert them to HTML. It has not been tested on a full mirror yet, because TheAnarcat is waiting for manpages group access and dependencies install (setuptools from backports and/or python-click, python-apt and python-debian) in manzarly. See the TODO file for more information about the current status of the project and limitations.

For Debian maintainers not wishing to operate on the Gitlab platform, there is also a collab-maint repository that is synchronised with Gitlab every hour.

Hardware

The service is running in manziarly.debian.org. It used to run on glinka.debian.org.

Forum

Discussions about manpages.debian.org can take place on the regular Teams/DDP channels, for example the #debian-doc IRC channel and debian-doc@lists.debian.org mailing list.

You can also subscribe to this wiki page to get updates, which also functions as an ad-hoc forum.