Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 108 lines (71 sloc) 3.173 kb
7caee2b Added README.md
Ivan Choo authored
1 TracWikiSync
2 ============
3
acade6c Updated README instructions
Ivan Choo authored
4 This [Trac](http://trac.edgewall.org/) plugin allows you to synchronize wiki pages between to separate Trac installations.
5
196ba32 Fixes typo in README
Ivan Choo authored
6 A common use case is to install a local Trac project on your workstation and synchronize the wiki pages with your remote Trac server. This allows you to bring the wiki content offline, or edit the content locally before batch updating to the remote server (useful when working over slow Internet/VPN connections).
41881b2 Updated README, not complete.
Ivan Choo authored
7
8
c5918ad Added permission detection, improved gui workflow, cleanup some redundan...
Ivan Choo authored
9 Features
10 ------------
41881b2 Updated README, not complete.
Ivan Choo authored
11
acade6c Updated README instructions
Ivan Choo authored
12 - Supports various type of synchronization states:
41881b2 Updated README, not complete.
Ivan Choo authored
13
acade6c Updated README instructions
Ivan Choo authored
14 - `MODIFED`: Local page has been modified and will be updated to the remote server
15
16 - `NEW`: Local page is new and will be updated to the remote server
41881b2 Updated README, not complete.
Ivan Choo authored
17
acade6c Updated README instructions
Ivan Choo authored
18 - `OUTDATED`: Remote page has been modified and will be copied from the remote server
41881b2 Updated README, not complete.
Ivan Choo authored
19
acade6c Updated README instructions
Ivan Choo authored
20 - `MISSING`: Remote page exists and will be copied from the remote server
41881b2 Updated README, not complete.
Ivan Choo authored
21
196ba32 Fixes typo in README
Ivan Choo authored
22 - `CONFLICT`: Both local and remote pages have been modified, you can choose to either update to or copy from the remote server
41881b2 Updated README, not complete.
Ivan Choo authored
23
acade6c Updated README instructions
Ivan Choo authored
24 - `SYNCED`: Both local and remote pages are identitical
41881b2 Updated README, not complete.
Ivan Choo authored
25
acade6c Updated README instructions
Ivan Choo authored
26 - `IGNORED`: Skip these pages during synchronization
41881b2 Updated README, not complete.
Ivan Choo authored
27
acade6c Updated README instructions
Ivan Choo authored
28 - Uses standard `GET` and `POST` methods for synchronization, no other Trac plugins required
41881b2 Updated README, not complete.
Ivan Choo authored
29
acade6c Updated README instructions
Ivan Choo authored
30 - Supports `BASIC`/`DIGEST` authentication
41881b2 Updated README, not complete.
Ivan Choo authored
31
32 - Supports batch synchronization
33
34 TODO
35 ----
36
37 - Implement attachment synchronization
7caee2b Added README.md
Ivan Choo authored
38
39 Installation and Requirements
40 -----------------------------
41
41881b2 Updated README, not complete.
Ivan Choo authored
42 Minimum requirements:
43
44 - Trac 0.12 >=
45
46 - Python 2.6 >=
47
acade6c Updated README instructions
Ivan Choo authored
48 Instructions:
49
1ed0cd9 Updated read me with version info
Ivan Choo authored
50 1. Install Trac and the latest [TracWikiSync](https://github.com/ivanchoo/TracWikiSync/zipball/master) (highly recommend using [virtualenvwrapper](http://www.doughellmann.com/projects/virtualenvwrapper/))<pre>
acade6c Updated README instructions
Ivan Choo authored
51 $ pip install trac
52 ...
1ed0cd9 Updated read me with version info
Ivan Choo authored
53 $ pip install TracWikiSync-xxx.zip
acade6c Updated README instructions
Ivan Choo authored
54 </pre>
55
56 2. Create a new Trac environment<pre>
57 $ trac-admin /path/to/myproject initenv
58 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
59 $ htdigest -c /path/to/myproject/.htpasswd myproject admin
60 ...
61 </pre>
62
63 3. Enable the plugin by adding the following lines in `myproject/conf/trac.ini`<pre>
41881b2 Updated README, not complete.
Ivan Choo authored
64 [components]
196ba32 Fixes typo in README
Ivan Choo authored
65 wikisync.* = enabled
c5918ad Added permission detection, improved gui workflow, cleanup some redundan...
Ivan Choo authored
66 </pre>
41881b2 Updated README, not complete.
Ivan Choo authored
67
acade6c Updated README instructions
Ivan Choo authored
68 4. Upgrade the Trac environment<pre>
69 $ trac-admin /path/to/myproject upgrade
70 ...
71 </pre>
72
73 5. Start Trac<pre>
74 $ tracd --port=8080 \
75 --auth=*,/path/to/myproject/.htpasswd,myproject \
76 /path/to/myproject
77 </pre>
78
79 User Permissions
80 ----------------
7caee2b Added README.md
Ivan Choo authored
81
c5918ad Added permission detection, improved gui workflow, cleanup some redundan...
Ivan Choo authored
82 Trac users require the following permissions:
83
84 - `TRAC_ADMIN`: To configure the remote server information in the admin panels
85
86 - `WIKI_ADMIN`: To perform synchronization
87
196ba32 Fixes typo in README
Ivan Choo authored
88 Bugs
89 ----
90
c5918ad Added permission detection, improved gui workflow, cleanup some redundan...
Ivan Choo authored
91 Please use [Issues](https://github.com/ivanchoo/TracWikiSync/issues)
92
eef7f33 Added LICENSE and updated README
Ivan Choo authored
93 License
94 -------
95
96 See LICENSE
97
7caee2b Added README.md
Ivan Choo authored
98 Version History
99 ---------------
100
ba3f767 Bumped to v0.2
Ivan Choo authored
101 - v0.1: Initial release.
102 - v0.2:
103 - Bugfix: UNKNOWN status is now correctly detected as NEW for new wiki
eef7f33 Added LICENSE and updated README
Ivan Choo authored
104 - Bugfix: Fixed NoneType pointer error when new wiki is created
105 - v0.3:
106 - Added LICENSE (better late than never)
107 - Bugfix: Fixed edge case where local/remote wiki is deleted and re-added, causing the synced version to be higher than actual version. Such cases will be marked as conflict.
108 - Bugfix: Fixed bug where empty remote wiki page throws Invalid local_version exception.
Something went wrong with that request. Please try again.