Den Rails Connector für CMS Fiona installieren

Installieren Sie den Rails Connector, um in Ihrem Rails-Projekt direkt auf Ihre CMS-Inhalte in der Datenbank zuzugreifen und diese für die Anzeige aufzubereiten.

Die folgende Anleitung bezieht sich auf den Rails Connector ab Version 6.7.3. Anleitungen zur Installation früherer Versionen finden Sie in den entsprechenden Handbüchern (PDF). Wenn Sie Informationen zum Update einer früheren Version des Rails Connectors auf die aktuelle Version benötigen, wenden Sie sich bitte an unseren Customer Service.

Voraussetzungen

  1. Die eingesetzte Version von CMS Fiona muss mindestens 6.7.2 sein.
  2. Installieren Sie CMS Fiona nach der Installationsanleitung.
  3. Installieren Sie die für den Rails Connector benötigte Software nach der Anleitung im Abschnitt Installationsvoraussetzungen.
  4. Da die SQLite-Datenbank nicht vom Rails Connector unterstützt wird, installieren Sie bitte zuerst eine MySQL-Datenbank für Ihre CMS-Fiona-Instanz. Gehen Sie vor wie im Abschnitt Eine andere Datenbank einbinden beschrieben.
  5. Wechseln Sie anschließend in das Projektverzeichnis Ihrer Applikation. 
    $ cd meinProjekt
  6. Bis Version 6.8.0: Kopieren Sie Ihre Lizenzdatei license.xml in das Verzeichnis config unterhalb des Projektverzeichnisses.

Installation

  1. Die Datei database.yml muss zusätzlich zu den Datenbank-Konfigurationen für die einzelnen Environments Ihrer Rails-Anwendung die Definition für die CMS-Fiona-Datenbank enthalten: 
    cms:
  adapter: mysql2
  database: MyFionaDB
  username: MyFionaDB-Read-User
  password: MyFionaDB-Read-User-Password
  socket: /var/run/mysqld/mysqld.sock
    Verwenden Sie für die Verbindung des Rails Connectors zur Fiona-Datenbank einen Datenbankbenutzer, der ausschließlich das Leserecht für die Datenbank hat.
  2. Fügen Sie die erforderlichen Rails-Connector-Gems zum Gemfilehinzu: 
    gem 'mysql2'
gem 'infopark_fiona_connector', '~> x.y.z'
    # or gem 'infopark_rails_connector', '~> 6.y.z'
    Installieren Sie anschließend die zusätzliche Software mittels bundler: 
    $ bundle install
  3. Die Gems enthalten neben Programm-Code auch Generatoren (engl.“generators"), um CMS-Daten auszuliefern und zusätzliche Features verwenden zu können. Führen Sie also anschließend den folgenden Befehl innerhalb Ihrer Rails-Anwendung aus: 
    $ rails generate rails_connector:install
      create  config/initializers/rails_connector.rb
      create  app/models/obj.rb
      create  config/local/configuration.rb
      append  app/assets/javascripts/application.js
        gsub  app/assets/stylesheets/application.css
      remove  public/index.html
      remove  app/assets/images/rails.png
        gsub  app/views/layouts/application.html.erb
        gsub  app/views/layouts/application.html.erb
    Dieser Befehl bindet die notwendigen CSS-Dateien aus dem Gem in app/assets/application.css sowie JavaScript-Dateien in app/assets/application.js ein. Ferner werden die Dateien config/initializers/rails_connector.rb sowie config/local/configuration.rb angelegt. Für die Bearbeitungselemente (edit markers) verwendet der Rails Connector die JavaScript-Bibliothek jQuery, die automatisch eingebunden wird.
  4. Mit Hilfe der Datei config/initializers/rails_connector.rb lässt sich die Funktionsweise des Rails Connectors anpassen. Sollte Ihre CMS-Instanz nicht defaultheißen, so können Sie den Instanznamen angeben, indem Sie die folgende Zeile des Initializers anpassen: 
    RailsConnector::Configuration.instance_name = 'Instanzname'
    Mit der Datei configuration.rb lässt sich das Rails-Projekt an die lokale Entwicklungsumgebung anpassen.
  5. Starten Sie den Rails-Application-Server mit dem folgenden Kommando: 
    $ rails s
    Sie können die Startseite des Servers danach mit Ihrem Browser unter http://localhost:3000 erreichen.

Nächste Schritte

  1. Um detaillierte Informationen zur Verwendung des Rails-Connector-APIs zu erhalten, lesen Sie bitte die RDoc. Starten Sie hierfür mit dem folgenden Befehl einen RDoc-Server: 
    $ gem server
    Dieses Kommando startet einen Gem-Server und liefert Ihnen eine URL, unter der Sie die Dokumentation Ihrer lokal installierten Gems lesen können. Öffnen Sie diese URL in ihrem Browser (normalerweise http://localhost:8808/) und navigieren zu infopark_rails_connector oder infopark_fiona_connector. Weitere Informationen zum Gem-Server finden Sie auf der RubyGems-Website.
  2. Wenn Sie die Rails-Anwendung in der Vorschau verwenden, konfigurieren Sie die Vorschau.
  3. Konfigurieren Sie auch das Deployment für die verschiedenen Umgebungen.