Wissensdatenbank
13 März 2017
2.414

Wissensdatenbank

API Dokumentation

Vorwort


ToDo

System vorbereiten


apt update && apt -y upgrade
apt -y install wget nano curl git


Installation


Ruby


gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL https://get.rvm.io | bash -s stable
rvm install 2.4
apt -y install ruby-execjs


Bundler


gem install bundler


Slate


cd /opt
git clone https://git.staddi99.com/Staddi99/slate.git
cd slate


Nginx


Um nun die Dokumentation im Web verfügbar zu machen, kann man entweder einen Webserver installieren oder die Dokumentation per rsync, sftp, ftp oder git veröffentlichen.
Hier zeige ich den Weg mit einem Webserver (Nginx).
apt -y install nginx


Konfiguration


Slate Vorschau


Um eine Vorschau der Dokumentation zu erstellen, führen Sie folgende Befehle aus:
bundle install
bundle exec middleman server

Nun ist Ihre Dokumentation unter

Dieser Link wurde entfernt. Links sind nur für Mitglieder sichtbar. Bitte melden Sie sich mit Ihrem Benutzernamen und Ihrem Passwort an und versuchen Sie es erneut.

verfügbar.
Lassen Sie Middleman nicht auf Ihrem Produktionsserver laufen. Middleman ist nicht darauf ausgelegt, auf einem öffentlichen Server sicher zu sein. Er ist nicht entworfen, um Seiten schnell zu laden. Er ist rein für die Entwicklung gedacht.

Slate Build


Um die Dokumentation in HTML umzuwandeln führen Sie folgende Befehle aus:
bundle install
bundle exec middleman build --clean

Die Dateien für den Webserver befinden sich nun unter /opt/slate/build.

Nginx Konfiguration


Um die HTML-Dateien der Dokumentation für Nginx zugänglich zu machen, müssen wir die Konfiguration anpassen.
nano /etc/nginx/sites-available/default

server {
listen 80 default_server;
listen [::]:80 default_server;

root /opt/slate/build;

# Add index.php to the list if you are using PHP
index index.html index.htm index.nginx-debian.html;

server_name _;

location / {
try_files $uri $uri/ =404;
}
}

Nun noch den Webserver neu starten:
/etc/init./nginx restart