source: subversion/applications/editors/potlatch/README.TXT

Last change on this file was 29695, checked in by bnesbitt, 4 years ago

We're sorry, the source code you have reached has changed. The new address is....

File size: 2.8 KB
Line 
1
2NOTE:
3The Potlatch 2 source code has moved.  Please see:
4http://wiki.openstreetmap.org/wiki/Potlatch_2/Developer_Documentation
5http://git.openstreetmap.org/potlatch2.git/
6
7
8
9
10
11============================================================================
12============================================================================
13============================================================================
14============================================================================
15============================================================================
16============================================================================
17============================================================================
18============================================================================
19============================================================================
20============================================================================
21
22
23
24== Compiling Potlatch ==
25
26=== Requirements ===
27
28You will need Ming (www.libming.net) and the Perl bindings.
29
30=== Against a local installation ===
31
32If you have the Rails port (full OSM codebase) set up on your machine, it's best to run Potlatch directly against that.
33
34To compile Potlatch, simply run:
35        perl potlatch.pl /path/to/rails_port/public/potlatch/potlatch.swf
36       
37If you'd like to enable a debug window, add --trace:
38        perl potlatch.pl --debug /path/to/rails_port/public/potlatch/potlatch.swf
39
40You can write to the debug window from the Potlatch source like this:
41        _root.chat.text="Some text";
42       
43If you're using Ming 0.3, add --ming3 to ensure that line widths are correct.
44
45=== Against the main OSM server ===
46
47You can also run Potlatch locally, talking to the main openstreetmap.org server. In this case, to compile it, run:
48        perl potlatch.pl --absolute potlatch.swf
49       
50This will compile the SWF to the current source directory. Then, to run Potlatch, open test.html in your web browser.
51
52Note that Flash Player has (really annoying) security restrictions that may prevent your local machine talking to a remote server, and vice versa. So on my OS X machine:
53       
54        file:///Users/richard/Sites/potlatch/test.html - DOESN'T WORK
55        http://127.0.0.1/~richard/potlatch/test.html - works
56        http://localhost/~richard/potlatch/test.html - works
57       
58
59== Authentication ==
60
61When Potlatch is run on the OSM site (or your local install of the same), it gets a token from Rails which it uses to authenticate.
62
63If you're running it locally without a full install of the Rails port, you won't have a token. Happily, Potlatch can also authenticate by user ID and password.
64
65To do this, find the reference to 'token' in test.html:
66    fo.addVariable('token','VeSiWDkofUzgLLx5DgAU4rh1Wn23ro');
67
68and change it to:
69    fo.addVariable('token','your_username:your_password');
70
71
72
73Richard Fairhurst
74richard@systemeD.net
Note: See TracBrowser for help on using the repository browser.