Merge branch 'overpass'
[rails.git] / CONFIGURE.md
1 # Configuration
2
3 After [installing](INSTALL.md) this software, you may need to carry out some of these configuration steps, depending on your tasks.
4
5 ## Populating the database
6
7 Your installation comes with no geographic data loaded. You can either create new data using one of the editors (Potlatch 2, iD, JOSM etc) or by loading an OSM extract.
8
9 After installing but before creating any users or data, import an extract with [Osmosis](http://wiki.openstreetmap.org/wiki/Osmosis) and the [``--write-apidb``](http://wiki.openstreetmap.org/wiki/Osmosis/Detailed_Usage#--write-apidb_.28--wd.29) task.
10
11 ```
12 osmosis --read-pbf greater-london-latest.osm.pbf \
13   --write-apidb host="localhost" database="openstreetmap" \
14   user="openstreetmap" password="" validateSchemaVersion="no"
15 ```
16
17 Loading an apidb database with Osmosis is about **twenty** times slower than loading the equivalent data with osm2pgsql into a rendering database. [``--log-progress``](http://wiki.openstreetmap.org/wiki/Osmosis/Detailed_Usage#--log-progress_.28--lp.29) may be desirable for status updates.
18
19 To be able to edit the data you have loaded, you will need to use this [yet-to-be-written script](https://github.com/openstreetmap/openstreetmap-website/issues/282).
20
21 ## Managing Users
22
23 If you create a user by signing up to your local website, you need to confirm the user before you can log in, which normally happens by clicking a link sent via email. If don't want to set up your development box to send emails to public email addresses then you can create the user as normal and then confirm it manually through the Rails console:
24
25 ```
26 $ bundle exec rails console
27 >> user = User.find_by_display_name("My New User Name")
28 => #[ ... ]
29 >> user.status = "active"
30 => "active"
31 >> user.save!
32 => true
33 >> quit
34 ```
35
36 ### Giving Administrator/Moderator Permissions
37
38 To give administrator or moderator permissions:
39
40 ```
41 $ bundle exec rails console
42 >> user = User.find_by_display_name("My New User Name")
43 => #[ ... ]
44 >> user.roles.create(:role => "administrator", :granter_id => user.id)
45 => #[ ... ]
46 >> user.roles.create(:role => "moderator", :granter_id => user.id)
47 => #[ ... ]
48 >> user.save!
49 => true
50 >> quit
51 ```
52
53 ## OAuth Consumer Keys
54
55 Three of the built-in applications communicate via the API, and therefore need OAuth consumer keys configured. These are:
56
57 * Potlatch 2
58 * iD
59 * The website itself (for the Notes functionality)
60
61 For example, to use the Potlatch 2 editor you need to register it as an OAuth application.
62
63 Do the following:
64 * Log into your Rails Port instance - e.g. http://localhost:3000
65 * Click on your user name to go to your user page
66 * Click on "my settings" on the user page
67 * Click on "oauth settings" on the My settings page
68 * Click on 'Register your application'.
69 * Unless you have set up alternatives, use Name: "Local Potlatch" and URL: "http://localhost:3000"
70 * Check the 'modify the map' box.
71 * Everything else can be left with the default blank values.
72 * Click the "Register" button
73 * On the next page, copy the "consumer key"
74 * Edit config/application.yml in your rails tree
75 * Uncomment and change the "potlatch2_key" configuration value
76 * Restart your rails server
77
78 An example excerpt from application.yml:
79
80 ```
81 # Default editor
82 default_editor: "potlatch2"
83 # OAuth consumer key for Potlatch 2
84 potlatch2_key: "8lFmZPsagHV4l3rkAHq0hWY5vV3Ctl3oEFY1aXth"
85 ```
86
87 Follow the same process for registering and configuring iD (`id_key`) and the website/Notes (`oauth_key`), or to save time, simply reuse the same consumer key for each.
88
89 ## Troubleshooting
90
91 Rails has its own log.  To inspect the log, do this:
92
93 ```
94 tail -f log/development.log
95 ```
96
97 If you have more problems, please ask on the [rails-dev@openstreetmap.org mailing list](http://lists.openstreetmap.org/listinfo/rails-dev) or on the [#osm-dev IRC Channel](http://wiki.openstreetmap.org/wiki/IRC)
98
99 ## Maintaining your installation
100
101 If your installation stops working for some reason:
102
103 * Sometimes gem dependencies change. To update go to your rails_port directory and run ''bundle install'' as root.
104
105 * The OSM database schema is changed periodically and you need to keep up with these improvements. Go to your rails_port directory and run:
106
107 ```
108 bundle exec rake db:migrate
109 ```
110
111 ## Testing on the osm dev server
112
113 For example, after developing a patch for the rails_port, you might want to demonstrate it to others or ask for comments and testing. To do this one can [set up an instance of the rails_port on the dev server in ones user directory](http://wiki.openstreetmap.org/wiki/Using_the_dev_server#Rails_Applications).
114
115 # Contributing
116
117 For information on contributing changes to the codes, see [CONTRIBUTING.md](CONTRIBUTING.md)
118
119 # Production Deployment
120
121 If you want to deploy The Rails Port for production use, you'll need to make a few changes.
122
123 * It's not recommended to use `rails server` in production. Our recommended approach is to use [Phusion Passenger](https://www.phusionpassenger.com/). Instructions are available for [setting it up with most web servers](https://www.phusionpassenger.com/documentation_and_support#documentation).
124 * Passenger will, by design, use the Production environment and therefore the production database - make sure it contains the appropriate data and user accounts.
125 * Your production database will also need the extensions and functions installed - see [INSTALL.md](INSTALL.md)
126 * The included version of the map call is quite slow and eats a lot of memory. You should consider using [CGIMap](https://github.com/zerebubuth/openstreetmap-cgimap) instead.
127 * The included version of the GPX importer is slow and/or completely inoperable. You should consider using [the high-speed GPX importer](http://git.openstreetmap.org/gpx-import.git/).
128 * Make sure you precompile the production assets: `RAILS_ENV=production rake assets:precompile`
129 * Make sure the web server user as well as the rails user can read, write and create directories in `tmp/`.