[ckan-changes] [okfn/ckan] 543d4b: [#519] Update source install docs for 2.0

Tue May 7 14:09:09 UTC 2013

  Branch: refs/heads/release-v2.0
  Home:   https://github.com/okfn/ckan
  Commit: 543d4b296e91850be75024ca6b5eb89412d37274
      https://github.com/okfn/ckan/commit/543d4b296e91850be75024ca6b5eb89412d37274
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    M doc/conf.py
    M doc/datastore-setup.rst
    M doc/install-from-source.rst
    M doc/solr-setup.rst
    M doc/test.rst
    M test-core.ini

  Log Message:
  -----------
  [#519] Update source install docs for 2.0

Update the source install and related docs (datastore setup, solr setup,
testing) and files (deployment.ini_tmp, test-core.ini) for CKAN 2.0.

The idea is to document the setup process that OKFN is currently using
on its servers, so that the deployment docs can become the docs for the
OKFN dev team and we can dogfood our own docs, instead of having a bunch
of wiki pages, READMEs, etc. that we follow and ignoring the "official"
docs. Hopefully those can all be deleted or cut down massively once this
is done.

So both the docs now describe the layout we use on our servers, where
there's space for multiple CKAN sites on the same server, with
virtualenvs in /usr/lib/ckan/ and config files in /etc/ckan/.

- Changed default virtualenv location from `~/pyenv` to `/usr/lib/ckan/default`

- Changed default config files dir to `/etc/ckan/default`

- Added tip for developers in source install docsS symlink `/usr/lib/ckan` and
  `/etc/ckan` to directories in your homedir to install ckan in your homedir

- Changed default database user from `ckanuser` to `ckan_default`

- Changed default database from `ckan_dev` to `ckan_default`

- Changed default datastore database from `datastore` to `datastore_default`

- Changed default datastore database user from `readonlyuser` to `datastore_default`

- Changed default test databases from `ckan_test` and `ckan_test_datastore` to
  `ckan_test` and `datastore_test`

- Changed default `ckan.site_id` from `ckan.net` to `default`

- Disabled file log handler, rely on Apache's log files only (as we do on our
  servers)

- Changed the docs to use restructured text substitutions for things like the
  paths to the virtualenv and config files, database names, etc. instead of
  typing them out each time

- Lots of minor formatting fixes and editing

So now we have:

    virtualenv:        /usr/lib/ckan/default
    development.ini:   /etc/ckan/default/development.ini
    production.ini:    /etc/ckan/default/production.ini
    ckan.site_id:      default
    Database user:     ckan_default
    Database:          ckan_default
    Datastore user:    datastore_default
    Datastore db:      datastore_default
    Test database:     ckan_test
    Test datastore db: datastore_test

Conflicts:

	ckan/config/deployment.ini_tmpl
	doc/install-from-source.rst
	doc/test.rst
	test-core.ini

  Commit: cc0a0342ef2e29fef0ef91f22ecfb74fbed3d65e
      https://github.com/okfn/ckan/commit/cc0a0342ef2e29fef0ef91f22ecfb74fbed3d65e
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/post-installation.rst

  Log Message:
  -----------
  [#519] Update post-installation docs

Make them fit with the changes in commit
6e1d325d61ea66cd197864dc9a5af5c65af183c0

  Commit: f51e1afa08b0139c11359fe4bd23fd40050c5cb8
      https://github.com/okfn/ckan/commit/f51e1afa08b0139c11359fe4bd23fd40050c5cb8
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/conf.py
    M doc/deployment.rst

  Log Message:
  -----------
  [#519] Update deployment docs

Uses the same directory structure as the updated source install docs, so
you can step through the source install docs and then the deployment
docs as written and it all works.

Also updated the apache.wsgi and sites-available files to match those
that we use on our servers.

Removed CORS setup instructions as this has been builtin since CKAN 1.5.

  Commit: d41bcc8adf240ce0825a74fe1f46ce37349ac37c
      https://github.com/okfn/ckan/commit/d41bcc8adf240ce0825a74fe1f46ce37349ac37c
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/install-from-source.rst

  Log Message:
  -----------
  [#519] Edit source install docs

Minor edits to install from source docs

  Commit: c35ce445a7dca3b96c68a2c15e8b2feebda894dd
      https://github.com/okfn/ckan/commit/c35ce445a7dca3b96c68a2c15e8b2feebda894dd
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/solr-setup.rst

  Log Message:
  -----------
  [#519] Edit solr setup docs

Minor edits to solr setup docs

  Commit: 467c0878efb7f60df4d1b849ee45d3a0644b6f26
      https://github.com/okfn/ckan/commit/467c0878efb7f60df4d1b849ee45d3a0644b6f26
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    M doc/conf.py
    M doc/filestore.rst

  Log Message:
  -----------
  [#519] Update FileStore setup instructions

  Commit: f81827de0410e6fb24332e93362eec9777171045
      https://github.com/okfn/ckan/commit/f81827de0410e6fb24332e93362eec9777171045
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M bin/travis-build

  Log Message:
  -----------
  [#519] Fix Travis build

Update the database and user names in travis build

Conflicts:

	bin/travis-build

  Commit: 95b1591fce790bced8a44319029f18bef86f2872
      https://github.com/okfn/ckan/commit/95b1591fce790bced8a44319029f18bef86f2872
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/solr-setup.rst

  Log Message:
  -----------
  [#519] Minor edits to solr setup docs

  Commit: 46c4900af17812fcbeb0fa18ddbdb5264e32d4bc
      https://github.com/okfn/ckan/commit/46c4900af17812fcbeb0fa18ddbdb5264e32d4bc
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/deployment.rst

  Log Message:
  -----------
  [#519] Add postfix to deployment docs

  Commit: b02962c4d52a1c9debb4b7ad1dd5177327872019
      https://github.com/okfn/ckan/commit/b02962c4d52a1c9debb4b7ad1dd5177327872019
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/datastore-setup.rst

  Log Message:
  -----------
  [#519] Minor edits to datastore docs

Minor edits to the datastore docs, from Dominik. See:

https://github.com/okfn/ckan/pull/807

  Commit: f81bd1a3354d703d4ea2d9b69de196efff8cc267
      https://github.com/okfn/ckan/commit/f81bd1a3354d703d4ea2d9b69de196efff8cc267
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/conf.py
    M doc/filestore.rst

  Log Message:
  -----------
  [#519] Docs: change restart_apache substitution to reload_apache

  Commit: cc5865689b2110e9076592f3c79ce479faedd461
      https://github.com/okfn/ckan/commit/cc5865689b2110e9076592f3c79ce479faedd461
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/deployment.rst
    M doc/email-notifications.rst
    M doc/install-from-source.rst

  Log Message:
  -----------
  [#519] Docs: use the reload_apache substitution

  Commit: eb27c3511249d442e665787efa24ec4b5e7af9ae
      https://github.com/okfn/ckan/commit/eb27c3511249d442e665787efa24ec4b5e7af9ae
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/deployment.rst

  Log Message:
  -----------
  [#519] Remove non-root URL deployment instructions

We've had reports from some users that this causes problems with some
CKAN features, so we don't want to recommend it until tested.

  Commit: 74c22602ce7e8a718a7e233dfc29d74b326d3270
      https://github.com/okfn/ckan/commit/74c22602ce7e8a718a7e233dfc29d74b326d3270
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/install-from-source.rst

  Log Message:
  -----------
  [#519] Replace seanh with `whoami` in source install docs

  Commit: a62f6fd605d9c5e823873f1580145348d6dc7241
      https://github.com/okfn/ckan/commit/a62f6fd605d9c5e823873f1580145348d6dc7241
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/solr-setup.rst

  Log Message:
  -----------
  [#519] Docs: changed 'supported' to 'recommended'

  Commit: ad1044da7c64c52b655392dcb5c5700a1edfe479
      https://github.com/okfn/ckan/commit/ad1044da7c64c52b655392dcb5c5700a1edfe479
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M bin/travis-build
    M doc/test.rst
    M test-core.ini

  Log Message:
  -----------
  Fix some master->release-v2.0 merge issues

2.0's test-core.ini file still imports development.ini, so it should not
specify its own databases and database users, for example. Also the docs
for creating the test databases and users are not needed in 2.0. This
change (changing the tests to use their own test DBs and users) is going
into 2.1, not 2.0.

  Commit: 4f0f4969caf84182bc2a5ca14692245e49ab08cd
      https://github.com/okfn/ckan/commit/4f0f4969caf84182bc2a5ca14692245e49ab08cd
  Author: amercader <amercadero at gmail.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    A ckan/config/install.py
    M setup.py

  Log Message:
  -----------
  [#746] Extend Pylons installer to tweak deployment.ini_tmpl

With the new 'paste.app_install' entry point on setup.py, we can define
a custom "installer" that basically allows us to define new variables to
be used on the deployment.ini_tmpl file. This is useful eg for defining
the ckan version and provide a link to the relevant documentation for
the configuration options.

  Commit: 2dbf75188f93aec5b4f794a11960793553ecb0cd
      https://github.com/okfn/ckan/commit/2dbf75188f93aec5b4f794a11960793553ecb0cd
  Author: amercader <amercadero at gmail.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/configuration.rst
    M doc/datastore-setup.rst

  Log Message:
  -----------
  [#746] Document datastore db url config options

And include them from the datastore setup documentation to avoid
duplication.

Conflicts:

	doc/datastore-setup.rst

  Commit: acdceb2dc72d928ce4ef3206ef4973140802f511
      https://github.com/okfn/ckan/commit/acdceb2dc72d928ce4ef3206ef4973140802f511
  Author: amercader <amercadero at gmail.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#746] Update configuration.rst

* Document ckan.email_notifications_since
* Remove duplicate search.facet.limits
* Minor formatting tweaks

Conflicts:

	doc/configuration.rst

  Commit: 9a25f6ef88600f1d7d90b941b1eddceb27bc3a7c
      https://github.com/okfn/ckan/commit/9a25f6ef88600f1d7d90b941b1eddceb27bc3a7c
  Author: amercader <amercadero at gmail.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#746] Document file store options in configuration.rst

TODO: Expand them

  Commit: 1daae62fca96ec6dd7ba2ccb1960055da96bd816
      https://github.com/okfn/ckan/commit/1daae62fca96ec6dd7ba2ccb1960055da96bd816
  Author: amercader <amercadero at gmail.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl

  Log Message:
  -----------
  [#746] Update deployment.ini_tmpl

Remove legacy  and unused options, add new ones. Change the structure to
follow more closely the documentation on configuration.rst. Remove all inline
comments to avoid having documentation in more than one place.

Conflicts:

	ckan/config/deployment.ini_tmpl

  Commit: 20ff491ebfaaf97f21f23aee5019ee553a60e0d6
      https://github.com/okfn/ckan/commit/20ff491ebfaaf97f21f23aee5019ee553a60e0d6
  Author: Dominik Moritz <domoritz at gmail.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M doc/datastore-setup.rst

  Log Message:
  -----------
  [#746] No : at end of sentence.

  Commit: ee89f8bc4c3f150989c7584f38530bbcc9b021e7
      https://github.com/okfn/ckan/commit/ee89f8bc4c3f150989c7584f38530bbcc9b021e7
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl

  Log Message:
  -----------
  [#746] Edit a docstring in deployment.ini_tmpl

Minor edits

  Commit: 85d106dd60ea4fbe96e9c388267a1f752781ec68
      https://github.com/okfn/ckan/commit/85d106dd60ea4fbe96e9c388267a1f752781ec68
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-07 (Tue, 07 May 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    M doc/configuration.rst

  Log Message:
  -----------
  [#746] Minor edits to configuration docs

Compare: https://github.com/okfn/ckan/compare/862fa7089c90...85d106dd60ea