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

Last change on this file since 18174 was 15001, checked in by richard, 10 years ago

New readme for building Potlatch

File size: 2.0 KB
Line 
1== Compiling Potlatch ==
2
3=== Requirements ===
4
5You will need Ming (www.libming.net) and the Perl bindings.
6
7The unit used by Ming to specify line widths has changed in recent versions. You will need to alter the first line of potlatch_assets.pl (all the sprites) depending which version you are using.
8
9If you are using current Ming:          $cw=1/20;
10If you are using an old Ming:           $cw=1;
11
12=== Against a local installation ===
13
14If you have the Rails port (full OSM codebase) set up on your machine, it's best to run Potlatch directly against that.
15
16To compile Potlatch, simply run:
17        perl potlatch.pl /path/to/rails_port/public/potlatch/potlatch.swf
18       
19If you'd like to enable a debug window, add --trace:
20        perl potlatch.pl --debug /path/to/rails_port/public/potlatch/potlatch.swf
21
22You can write to the debug window from the Potlatch source like this:
23        _root.chat.text="Some text";
24       
25=== Against the main OSM server ===
26
27You can also run Potlatch locally, talking to the main openstreetmap.org server. In this case, to compile it, run:
28        perl potlatch.pl --absolute potlatch.swf
29       
30This will compile the SWF to the current source directory. Then, to run Potlatch, open test.html in your web browser.
31
32Note 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:
33       
34        file:///Users/richard/Sites/potlatch/test.html - DOESN'T WORK
35        http://127.0.0.1/~richard/potlatch/test.html - works
36        http://localhost/~richard/potlatch/test.html - works
37       
38
39== Authentication ==
40
41When 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.
42
43If 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.
44
45To do this, find the reference to 'token' in test.html:
46    fo.addVariable('token','VeSiWDkofUzgLLx5DgAU4rh1Wn23ro');
47
48and change it to:
49    fo.addVariable('token','your_username:your_password');
50
51
52
53Richard Fairhurst
54richard@systemeD.net
Note: See TracBrowser for help on using the repository browser.