{"id":22538254,"url":"https://github.com/cfpb/ckan-installer","last_synced_at":"2025-04-09T20:20:51.881Z","repository":{"id":27544404,"uuid":"31025931","full_name":"cfpb/ckan-installer","owner":"cfpb","description":null,"archived":false,"fork":false,"pushed_at":"2022-04-28T21:31:51.000Z","size":473,"stargazers_count":6,"open_issues_count":3,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-23T22:12:26.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cfpb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-19T16:58:50.000Z","updated_at":"2020-02-03T15:59:30.000Z","dependencies_parsed_at":"2022-09-02T11:10:55.838Z","dependency_job_id":null,"html_url":"https://github.com/cfpb/ckan-installer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fckan-installer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fckan-installer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fckan-installer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fckan-installer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cfpb","download_url":"https://codeload.github.com/cfpb/ckan-installer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248104103,"owners_count":21048282,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-07T11:11:00.700Z","updated_at":"2025-04-09T20:20:51.847Z","avatar_url":"https://github.com/cfpb.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CKAN\n\n**Description**:  A simple vagrant box with provisioning scripts to stand up an out-of-the-box version of CKAN.  \n\nOther things to include:\n\n  - **Technology stack**: \n   - Python 2.7\n   - Apache\n   - Postgres\n   - Solr\n   - CKAN\n  - **Status**:  1.0  Should be stable but we are still making refinements and looking for feedback\n\n## Dependencies\n- **Vagrant / Virtualbox** - creates the VM that is built by Ansible.  \nInstallation instructions can be found here: http://docs.vagrantup.com/v2/installation/\n- **Ansible** - provisions the VM.  \n    Installation: `pip install ansible` from your python virtual environment\n\n## Installation\n\n1. `vagrant up`\n2. Once provisioning completes, open your browser to [localhost:8080](http://localhost:8080) and you should see CKAN\n\n### Starting / Stopping the VM\nTo start the vagrant box: `vagrant up`  \nTo stop the vagrant box: `vagrant halt`  \n\n## Installing on Aurora\nIf you would like to install ckan onto a locally running instance of [Aurora](https://github.com/cfpb/aurora), follow the steps below.\nSince each Aurora app consists of a single ephemeral foreground process, this technique relies on installing CKAN the traditional way first and using its instance of PostgreSQL/Solr with an Apache process running on Mesos via Marathon.\n\n1. `cd` into the `provisioners/` folder in this repo and run `vagrant up`\n2. Create SSH tunnels to the PostgreSQL/Solr instances: `vagrant ssh -- -L 8983:localhost:8983 -L 5432:localhost:5432`\n3. Visit [10.0.1.31:8080](http://10.0.1.31:8080) to access the marathon UI and make a new app\n4. Edit the app's config, click the \"json\" toggle in the upper right, and paste the json from `marathon_app.json` (located in the same directory as this readme).\n5. Upon saving the config, you'll be prompted to (re)deploy the application. Do so and give it time to install (~10 minutes?)\n6. Open the Mesos UI at [10.0.1.31:5050](http://10.0.1.31:5050). Locate your job under the \"Active Tasks\" section and click its \"Sandbox\" link.\n7. Click the \"stdout\" link and confirm that the bottom says `PLAY RECAP` and that you see `failed=0`. If there is no play recap yet, you probably need to wait for ansible to finish running\n8. Go back to the [Marathon UI](http://10.0.1.31:8080) and locate your task. Click the link undereath the ID (something like '10.0.1.34:31029').\n9. This should open the Data Catalog in a new tab. If you receive an error page, go back to the sandbox and check `stdout`, `stderr` and `httpd/apache.error.log` for error messages.\n\n## Getting Started\nFor information about how to use CKAN, please see the [official documentation](http://docs.ckan.org/en/latest/user-guide.html)\n\n**Customizing Look and Feel**  \nSee the section on [Customizing Look and Feel](http://docs.ckan.org/en/latest/sysadmin-guide.html#customizing-look-and-feel) in the official documentation\n\n## Useful commands\nThe ckan docs contain several commands that are useful for administering the ckan instance. Some of them are listed here for convenience:\n\nMake a user an admin:\n\n    source /ckan/default/bin/activate \u0026\u0026 cd /ckan/default/src/ckan \u0026\u0026 paster sysadmin add \u003cusername\u003e -c /ckan/config/default/config.ini\n\nRe-index solr  (required after upgrade)\n\n    source /ckan/default/bin/activate \u0026\u0026 cd /ckan/default/src/ckan \u0026\u0026 paster search-index rebuild -r --config=/ckan/config/default/config.ini\n\n## Upgrading CKAN\nIf you want to upgrade the version of ckan, follow the instructions in the [CKAN Docs](http://docs.ckan.org/en/latest/maintaining/upgrading/upgrade-source.html).\n\nNote that you must upgrade one minor version at a time (you can't go straight from 2.3 to 2.5, but instead must do `2.3 -\u003e 2.4 -\u003e 2.5`).\n\nFurthermore, there is a bug in version 2.5.0, so the actual list of tags should be: `ckan-2.3` -\u003e `ckan-2.4.0` -\u003e `ckan-2.5.3` -\u003e `ckan-2.6.0`.\n\n## Developers\n\nCheck out the [Guide to Extending](http://docs.ckan.org/en/latest/extensions/tutorial.html) in the offical documentation\n\nIf you are building with the extra fields, check out the [local developement guide](build-locally.md)\n\n### Customizing this VM  \nIf you make any changes to the `provisioners/group_vars/local` or any of the default variables, you will need to re-provision the VM.  Simply run `vagrant provision` and the changes will be applied.  \n\n## How to test the software\n\nAt the moment there are no tests for this codebase.  \n\n## Known issues\n\nNone\n\n## Getting help\n\nIf you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.\n\n## Getting involved\n\nPlease see our [CONTRIBUTING](CONTRIBUTING.md) file for more information about contributing\n\n## Troubleshooting  \n\n### Solr \nIf you can't seem to access solr in Vagrant (checking http://localhost:8983/solr), try stopping the iptables service:\n`sudo service iptables stop`\n\n----\n\n## Open source licensing info\n1. [TERMS](TERMS.md)\n2. [LICENSE](LICENSE)\n3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)\n\n\n----\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fckan-installer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfpb%2Fckan-installer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fckan-installer/lists"}