Jak zainstalować Raneto na Ubuntu 17.10

• Wymagania wstępne
• Logowanie
• Instalowanie Node.js i PM2
• Instalowanie Raneto
• Dalsza konfiguracja
• Dodawanie stron
• Dodawanie kategorii

Raneto to darmowa baza wiedzy o otwartym kodzie źródłowym, zbudowana na Node.js, łatwa w konfiguracji i obsłudze, a także łatwa w administrowaniu. Kategorie i strony są napisane w Markdown, co ułatwia edycję. Jeśli Markdown nie jest twoją rzeczą, Raneto pozwala ci również na używanie HTML.

Wymagania wstępne

• VPS z zainstalowanym Ubuntu 17.10.
• Dostęp SSH do twojego VPS.
• Podstawowa znajomość terminala Linux.

Logowanie

Najpierw musimy zalogować się do naszego serwera za pomocą SSH. Aby to zrobić, otwórz swojego ulubionego klienta SSH.

ssh root@SERVER_IP

Po wprowadzeniu hasła (można je uzyskać z pulpitu nawigacyjnego Vultr) zostaniesz zalogowany do swojego VPS.

Instalowanie Node.js i PM2

Raneto działa na Node.js, środowisku wykonawczym i frameworku javascript. W tym samouczku będziemy używać Node.js v8 ze względu na jego długoterminową obsługę. Rozpocznij instalację, wpisując następujące polecenie.

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -

Po zakończeniu działania tego skryptu możesz uruchomić główną instalację.

sudo apt-get install -y nodejs

Po zakończeniu tego instalatora będziesz mieć aktualną kopię pliku Node.js zainstalowanego na twoim VPS. Następnie zainstalujemy PM2, menedżera procesów dla Node.js, który ułatwi uruchamianie Raneto (i wielu innych aplikacji Node.js).

npm install pm2 -g

Mamy teraz całe oprogramowanie potrzebne do zainstalowania Raneto.

Instalowanie Raneto

Użyjemy Gita do sklonowania repozytorium Raneto na naszym serwerze.

git clone https://github.com/gilbitron/Raneto.git

Spowoduje to utworzenie folderu o nazwie Raneto. Wejdź do folderu.

cd Raneto

Zainstaluj NPM.

npm install

Uruchom Gulp, wpisując następujące polecenie.

npm run gulp

Po zakończeniu działania Gulp możemy uruchomić naszą aplikację za pomocą jednego z dwóch poniższych poleceń.

npm start
# or
npm example/server.js

Teraz będziesz mógł uzyskać dostęp do nowej instalacji Raneto, przechodząc do SERVER_IP:3000. Pozostała część tego samouczka nauczy Cię, jak dalej konfigurować Raneto, tworzyć nowe strony, dodawać kategorie, dostosowywać sortowanie, dodawać niestandardową stronę główną i edytować szablon.

Dalsza konfiguracja

Masz teraz domyślną instalację Raneto hostowaną na twoim VPS. Zanim zaczniesz robić cokolwiek innego, sugeruję wprowadzenie kilku zmian w domyślnej konfiguracji i konfiguracji.

Rzućmy okiem config.default.js, który znajduje się w examplefolderze. Ten plik konfiguracyjny jest dość długi, ale proszę nie być przytłoczonym, ponieważ jest mocno komentowany. Oto właściwości, które należy edytować:

• site_title - Zmień to na tytuł swojej witryny.
• base_url- Powinien to być adres URL Twojej witryny. Może być używany jako zmienna podczas edycji stron.
• support_email- Zmień to na prawidłowy adres e-mail. Pojawi się w stopce strony.
• copyright - Tekst stopki.
• analytics - Dodaj tutaj kod śledzenia Google Analytics.
• allow_editing - Czy chcesz móc edytować pliki za pomocą edytora internetowego?
• authentication_for_read - Czy chcesz, aby ludzie logowali się, aby wyświetlić stronę internetową?
• credentials - Dodaj użytkowników tutaj, jeśli logowanie jest włączone.
• locale - język.
• datetime_format - Format daty i godziny.
• home_meta - Edytuj to, aby zmienić meta informacje na stronie głównej.
• table_of_content - Czy Raneto powinien wyświetlić spis treści?

Korzystanie z edytora online

Raneto posiada łatwy w użyciu interfejs online do zarządzania stronami, kategoriami i nie tylko. Chociaż nie pozwala ci to zrobić wszystkiego, z pewnością jest pomocny, jeśli chcesz dokonać szybkiej edycji w podróży.

Możesz uzyskać do niego dostęp, włączając ustawienie config.default.js(jak wspomniano powyżej), a następnie odwiedzając VPS i klikając przycisk logowania w prawym górnym rogu. Wprowadź swoją nazwę użytkownika i hasło (możesz je zmienić config.default.js) i kliknij login. Po prostu kliknij stronę, którą chcesz edytować, kliknij Actionsmenu i wybierz czynność, którą chcesz wykonać. Możesz dodawać strony, naciskając +przycisk obok nazwy kategorii, i możesz tworzyć kategorie za pomocą pola wprowadzania w lewym górnym rogu.

Dodawanie stron

Dodawanie stron jest tak proste, jak utworzenie nowego .mddokumentu Markdown ( ) w example/contentfolderze.

Po utworzeniu nowego pliku Markdown ważne jest, aby dodać kilka podstawowych informacji na początku pliku. Otwórz plik w swoim ulubionym edytorze tekstu. Musimy dodać następujące na górze pliku.

/*
 Title: Enter your page title here, if none is added, the file-name will be used
 Description: Enter your page's description here (for search engines and the site search feature)
 ShowOnHome: true/false
 */

W razie potrzeby możesz również użyć następujących zmiennych na swoich stronach:

• %base_url% - Pozwala to na podanie adresu URL Twojej witryny.
• %image_url% - Pozwala to uzyskać podstawowy adres URL katalogu obrazów.

Dodawanie kategorii

Możesz łatwo dodawać kategorie do swojej bazy wiedzy. Po prostu utwórz nowy folder w example/contentkatalogu i umieść w tym folderze strony, które chcesz znaleźć w tej kategorii. Załóżmy na przykład, że chcieliśmy kategorii o nazwie helpze stronami o nazwie contact, help-mei awesome. Pliki wyglądałyby następująco:

/example/content/help/contact.md
/example/content/help/help-me.md
/example/content/help/awesome.md

Możesz dodać tyle podfolderów, ile chcesz wewnątrz kategorii.

Kategorie mogą również zawierać meta informacje. Utwórz plik o nazwie metaw folderze kategorii. Obsługiwane są następujące atrybuty (wszystkie opcjonalne):

• Tytuł - zastępuje tytuł na podstawie nazwy folderu.
• Sortuj - umożliwia sortowanie kolejności kategorii, działa tak samo jak sortowanie stron.
• ShowOnHome - prawda / fałsz.

Niestandardowa strona główna

Jeśli chcesz dodać niestandardową stronę główną, wszystko, co musisz zrobić, to dodać plik przeceny index.mddo swojego example/contentfolderu.

Sortowanie stron

Raneto automatycznie sortuje strony alfabetycznie, ale możesz zastosować sortowanie ręczne, dodając Sortelement do meta strony. Wartość sort musi być liczbą całkowitą, na przykład:

Sort: 7

Ta strona pojawiałaby się teraz przed stronami o wartości sortowania 8 lub większej, ale po stronach o wartości 6 lub mniejszej.

Zmiana szablonu

Jeśli znasz HTML lub CSS, możesz łatwo zmienić wygląd swojej instalacji Raneto. Raneto używa Handlebars, języka szablonów JavaScript, który moduluje edycję HTML. Pliki motywów można znaleźć w themes/defaultfolderze. Jeśli chcesz uzyskać więcej informacji na temat edycji szablonów Renato, możesz odwiedzić ich sekcję pomocy . Po zakończeniu edycji szablonu ponownie uruchom aplikację.