Iain R. Learmonth Iain R. Learmonth Change Onionoo links to point to new location (Fixes: #23802) ffc651dff @ 2018-04-02 19:15:01
about Updates all Relay Search URLs to new location (Fixes: #25286) 2018-04-02 19:06:38
cgi-bin first cut of the new, shiny tor website as wml. 2010-07-09 03:55:22
css Bug 25017: Remove 2017 donation banner from homepage 2018-01-25 06:14:50
docs Bug 23917: Update gk's GPG subbkeys on website 2018-04-02 19:12:35
donate Bug 24878: Lower Bitpay minimum to 5 USD. 2018-01-12 09:38:29
download Remove openbsd from install Tor instruction add to download easy en 2018-01-22 22:56:34
eff Fix broken blog link (thanks dmr) 2016-09-23 06:19:35
en Updates all Relay Search URLs to new location (Fixes: #25286) 2018-04-02 19:06:38
getinvolved Change Onionoo links to point to new location (Fixes: #23802) 2018-04-02 19:15:01
images Move Brad to past contributors section 2018-01-30 18:50:33
include Tor is released. 2018-03-29 17:20:28
js Bug 25017: Remove 2017 donation banner from homepage 2018-01-25 06:14:50
keys Add Kat's public key. 2018-03-25 20:57:08
press Move video and subs to extra 2018-03-30 16:30:46
projects Change Onionoo links to point to new location (Fixes: #23802) 2018-04-02 19:15:01
tordnsel Fix #9736 2014-10-19 15:09:26
.gitignore Update gitignore to avoid editor drops 2018-02-06 11:09:06
.htaccess Add redirect rule for relay guide 2018-02-14 16:42:28
Makefile Tor is released. 2018-03-29 17:20:28
Makefile.common Add language translation for download page 2017-11-16 18:39:18
Makefile.local.sample Revert change to makefile.local.sample 2017-12-26 12:03:00
README.md Update README regarding how to minify files 2017-07-03 10:56:28
favicon.ico add a favicon.ico 2010-10-18 06:30:52
googlec8083ab726611228.html Add yes-we-own-this-website token for google. Will remove later. 2015-10-15 18:04:02
po2wml.sh Minify JS and CSS 2017-07-03 09:05:56
robots.txt Added subheads to the FAQ page; applied ln5's patch 2014-02-09 03:55:13
update-mirrors.pl update the mirrors page, have the script update the csv list with last status. 2013-12-06 16:54:04
wml2po.sh Remove unused version entries 2016-02-05 22:05:42

How to contribute

Thanks for being interested to work on the website, I tried to make a simple how-to for you to quickly get you setup:

Step 1: Clone the git repo.

git clone https://git.torproject.org/project/web/webwml.git
cd webwml

Step 1b: Create a bare public repository (i.e on Github), where you'd push your commits to. Make sure you're in webwml directory, and run:

git remote add pick-a-name your-git-url

Example: git remote add tpo-gh git@github.com:mrphs/tpo.git

Step 2: Create and switch to a new branch.

In the following example, I've named my branch "docs" as I'm planning to work on the documentations.

git checkout -b docs

Step 3: Now you can start working on website and make changes. Once you're done, commit and push it to your public repo.


git push tpo-gh docs

Step 4: Open a new ticket on trac with a link to your shiny new repo/branch.

Building website

Torproject website is being built and published automatically. To quickly get set up and build website locally, simply follow these steps:

Step 1: Get the website's build dependencies.

sudo apt-get install wml asciidoc

Step 2: Configure where to find your tor git repository. It needs this to make the manual page.

git clone https://git.torproject.org/project/web/webwml.git
cd webwml
cp Makefile.local.sample Makefile.local

Note: Change the TORGIT in Makefile.local to point to your tor git repo.

Step 3: Make the website.


You should now be able to point your browser at the locally generated site...


Troubleshooting the build

The build fails with "Invalid object name".

If you get an error like...

---- Contents of STDERR channel: ---------
fatal: Invalid object name 'tor-'.
asciidoc: FAILED: manpage document title is mandatory
No manpage because of asciidoc error or file not available from git at
/tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.

This means your tor repository is out of date. Update your tor git repository.

Some information regarding working with minified CSS and JS sources

If you want to edit any of the CSS or JS sources, please bear in mind that the HTML uses the minified versions. We keep in the repository both versions side-to-side. Once you edit the original source make sure you generate the minified version again. Most editors have plugins to minify CSS and JS files. On Debian it is possible to install the yui-compressor package and use it as follows:

yui-compressor myfile.js -o myfile-min.js

If you are wondering why is it "cool" to minify sources even though compression is used on the server, please consider that Minification can be well be used in combination with gzipping sources. Minification does a lot of additional things that compression doesn't do. During minification comments are removed, long variables are renamed to shorter variable names, etc. Transferred data can be significantly smaller after minification, than by simply compressing the original. Although this depends a lot on the original source, minifying helps with mobile browsers and slower connections.

More detailed instructions from Roger

Note: This section was written when website repo was still on svn, and it wasn't built automatically.

Here are the instructions I sent David Fifield when he asked about editing the website. I hope they are useful for you too! --Roger

Copy Makefile.local.sample to Makefile.local in your webwml/ directory. Point TORGIT to a tor git.

Then apt-get install wml and (alas) probably a shocking number of other debs. Then you can type 'make' and it will build the website for you locally. It's probably a smart move to see whether 'make' works before you git commit any changes to the wml files.

You can edit docs/en/pluggable-transports.wml (and that is the right source file to edit, not the html). But go take a look at that file. You'll notice it has a bunch of tags like . If you're just bumping version numbers, you probably just want to change the definition of those tags. They're in include/versions.wmi

(Every once in a while you may need to edit pluggable-transports.wml too -- generally when you change the file name so drastically that just changing the versions.wmi tags isn't enough.)

Pushes to the master branch of the git repository will cause the website to get re-built and published. Pushing to the staging branch will update www-staging.torproject.org.

Alas, https://www.torproject.org/dist/ isn't in version control. You write to it by ssh'ing to dist-master.torproject.org and going to /srv/dist-master.torproject.org/htdocs/ and then sticking your stuff there. When you want it to go live, you run "static-update-component dist.torproject.org" on dist-master.

Weasel has hopes that somebody will write some scripts to make maintaining packages in dist/ less awful -- automatically check that they have signatures and that the sigs match, that the items on the website are in fact in dist, only allow certain people to put files in certain places, etc. One day! :)