Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
Add links to documentation and installation
Browse files Browse the repository at this point in the history
**Problem**
A few users have asked in #theforeman lately about this plugin, yet they normally arrive at http://projects.theforeman.org/projects/foreman/wiki/Rundeck_Integration and have no guidance about how to proceed since it makes no mention of the plugin.

**Solution**
I've updated the wiki page to point to this repository, and we should consider moving it to a proper manual in theforeman.org. I also tried to update this README with a few more points of contact for help.
  • Loading branch information
dLobatog committed Oct 21, 2015
1 parent 2fb41c9 commit 9254547
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
# ForemanHostRundeck
# Foreman Host Rundeck

Creates a yaml representation of rundeck on hosts

* Website: [TheForeman.org](http://theforeman.org)
* ServerFault tag: [Foreman](http://serverfault.com/questions/tagged/foreman)
* Issues: [foreman_rundeck Redmine](http://projects.theforeman.org/projects/rundeck/issues)
* Wiki: [Foreman wiki](http://projects.theforeman.org/projects/foreman/wiki/About)
* Community and support: #theforeman for general support, #theforeman-dev for development chat in [Freenode](irc.freenode.net)
* Mailing lists:
* [foreman-users](https://groups.google.com/forum/?fromgroups#!forum/foreman-users)
* [foreman-dev](https://groups.google.com/forum/?fromgroups#!forum/foreman-dev)

## Installation

See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
for how to install Foreman plugins
Please see the Foreman manual for appropriate instructions:

* [Foreman: How to Install a Plugin](http://theforeman.org/plugins/)

### Red Hat, CentOS, Fedora, Scientific Linux (rpm)

Set up the repo as explained in the link above, then run (on 1.10+):

# yum install tfm-rubygem-foreman_host_rundeck

On 1.9:

# yum install ruby193-rubygem-foreman_host_rundeck

### Debian, Ubuntu (deb)

Set up the repo as explained in the link above, then run:

# apt-get install ruby-foreman-host-rundeck

### Bundle (gem)

Add the following to bundler.d/Gemfile.local.rb in your Foreman installation directory (/usr/share/foreman by default)

$ gem 'foreman_host_rundeck'

Then run `bundle install` and `foreman-rake db:migrate` from the same directory

--------------

To verify that the installation was successful, go to Foreman, top bar **Administer > About** and check 'foreman_host_rundeck' shows up in the **System Status** menu under the Plugins tab.

## Usage

[Our wiki covers the basics of Rundeck integration](http://projects.theforeman.org/projects/foreman/wiki/Rundeck_Integration)

## Contributing

Expand Down

0 comments on commit 9254547

Please sign in to comment.