Opened 9 years ago

Closed 8 years ago

#2706 closed defect (implemented)

Perhaps we should have the doxygen content on a real site somewhere

Reported by: nickm Owned by: phobos
Priority: Medium Milestone:
Component: Webpages/Website Version:
Severity: Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

If the doxygen content at

http://www.wangafu.net/~nickm/tor/doc/doxygen/html/

is useful to people, we should put it (and other stuff like it) on an official site somewhere, eventually. It ought to get periodically rebuilt.

Child Tickets

Change History (6)

comment:1 in reply to:  description Changed 9 years ago by phobos

Replying to nickm:

If the doxygen content at

http://www.wangafu.net/~nickm/tor/doc/doxygen/html/

is useful to people, we should put it (and other stuff like it) on an official site somewhere, eventually. It ought to get periodically rebuilt.

Can you document the setup? We can host it on doxygen.tpo and mirror it between the three webservers.

comment:2 Changed 8 years ago by phobos

Status: newaccepted

now that we can get new vms, bringing this back up again so I can make it happen

comment:3 Changed 8 years ago by phobos

although, i doubt we need a new vm. maybe just a doxygen directory we include in the docs/ section of the website.

comment:4 Changed 8 years ago by nickm

Can you document the setup? We can host it on doxygen.tpo and mirror it between the three webservers

It's pretty trivial. I have a crontab entry on moria that says:

20 6 * * * $HOME/bin/update-doxygen.sh

{That is, "please run update-doxygen.sh once every day at 6:20")

The relevant part of update-doxygen.sh is:

cd ~/public_html/tor
git pull
sh autogen.sh
./configure
doxygen

where ~/public_html/tor is a git checkout (OVER SSH) of the tor master branch. This makes ~/public_html/tor/doc/doxygen get the doxygen output.

although, i doubt we need a new vm. maybe just a doxygen directory we include in the docs/ section of the website.

This is not a terribly resource-intensive process, though you want to make sure that you're using an authenticated method to pull the Tor code -- otherwise an attacker could run arbitrary code on your webserver.

comment:5 Changed 8 years ago by phobos

temporarily, http://doxygen.torproject.org exists. I'd really like to move this to https://www.torproject.org/docs/doxygen

comment:6 Changed 8 years ago by phobos

Resolution: implemented
Status: acceptedclosed

Ok, moved doxygen.torproject.org to the production webserver.

Note: See TracTickets for help on using tickets.