forked from I2P_Developers/i2p.www
abb969b6cf
* ctags are case-sensitive, and the dataspecs use CamelCase. * HTML anchor tags are case-sensitive. The old specs used CamelCase to match the ctags, and the existing documentation references them extensively. * reStructuredText links are case-insensitive, and the HTML anchor tags that it generates are lower case. Therefore, the links in the .rst files are given in CamelCase, and the dataspec formatters convert this to lower case for links. In direct HTML references (in specs or other areas of documentation), lower case must be used (to be fixed). Command to generate the file: cd i2p2www/spec && ctags -f spectags --langdef=rst --langmap=rst:.rst --regex-rst=/_type-\([a-zA-Z0-9]+\)/\\1/t,type/ --regex-rst=/_struct-\([a-zA-Z0-9]+\)/\\1/s,struct/ --regex-rst=/_msg-\([a-zA-Z]+\)/\\1/m,msg/ -R -n *.rst
I2P website
To run locally (for testing purposes):
-
Install proxychains, configure it for Tor
-
Pull in the dependencies:
$ proxychains ./setup_venv.sh(you can also pull them non-anon by leaving out proxychains)
-
Compile translations (if you want to see them):
$ ./compile-messages.sh -
Start the webserver:
$ ./runserver.py -
Open the site at http://localhost:5000/
Running a mirror
If you want to mirror the I2P website, thanks! Here is a checklist:
- Do not edit any of the files in
i2p2www/- In particular, do not change the
CANONICAL_DOMAINvariable ini2p2www/__init__.py, it needs to point to the official site for SEO.
- In particular, do not change the
- If you need to edit variables in
etc/update.vars, copy the file toetc/update.vars.customand edit appropriately. The only variable you may need to edit isMTNURLinetc/update.vars(if your Monotone client tunnel is listening on a different port). - If you want to enable caching, copy
i2p2www/settings.py.sampletoi2p2www/settings.pyand edit appropriately. - Add
./site-updater.shto your crontab. This will keep the site updated, recompile the translations when necessary, and touch a file in/tmp/(look inetc/update.varsfor the filename, your webserver should restart WSGI when the timestamp of this file changes).
Updating translations
-
Pull new and updated translations from Transifex:
$ tx pull -a -
Correctly format the translations:
$ ./update-existing-po.sh -
Check in the updated translations:
$ mtn ci i2p2www/translations/ -m "Updated translations" -
Check in any new translations:
$ mtn add -R i2p2www/translations/ && mtn ci i2p2www/translations/ -m "New translations" -
Update the POT files with any changes to the website text:
$ ./extract-messages.sh -
Update the translations with any changes to the website text:
$ ./update-existing-po.sh -
Check in any changes to the website text:
$ mtn ci pots/ i2p2www/translations/ -m "Updated translation strings" -
Push website text changes to Transifex:
$ tx push -s