RESTBase/Installation/pl



Pobieranie RESTBase ze źródła
Możesz wykonać tę operację z dowolnego folderu, w którym masz uprawnienia.

Pobierz z git:

Możesz też pobrać plik ZIP z repozytorium projektu i wyodrębnić go.

Install node dependencies
RESTBase has been tested with node.js version 10.

Z katalogu \home\TY\RESTBase\project (np. na UBUNTU), zainstaluj zależności Node przy użyciu npm (część nodejs):

Konfiguracja
Skopiuj przykładową konfigurację:

Edytuj plik config.yaml w tych częściach:


 * Nie musisz niczego zmieniać ani martwić się tą sekcją, chyba że uruchomisz prywatną wiki (zobacz pytania).


 * jest podstawową domeną twojej wiki (lub identyfikator, jeśli masz kilka wiki na różnych ścieżkach tej samej domeny). Na przykład, dla MediaWiki jest to . Jest używany jako ścieżka identyfikatora w przypadku, gdy używasz tego samego serwera dla wielu wiki. For use with Parsoid in MediaWiki 1.35+, the domain must match exactly the host portion of your wiki's   configuration.


 * jest lokalizacją  Twojej wiki. Na przykład, punktem końcowym API MediaWiki jest mediawiki.org/w/api.php. Zobacz.
 * jest punktem końcowym, ponieważ można uzyskać do niego dostęp z Internetu. Jeśli serwer proxy obsługuje ruch bezpośrednio z apache/nginx do tej usługi, to możesz użyć adres URL taki jak . Zalecane dla osób (aby uniknąć problemów), które nie mają dostępu do niestandardowych portów.


 * For MediaWiki 1.35 and later,  is the location of your wiki's  . For example, MediaWiki's REST endpoint is mediawiki.org/w/rest.php. See.
 * In MediaWiki 1.34 and earlier, using, the  entry must correspond to the URL and port of your Parsoid server. Jeśli twoje serwery Parsoid i RESTBase znajdują się na tym samym komputerze, to   jest prawidłowym adresem URL. Parsoid/JS used   as its default.


 * dbname: RESTBase, do przechowywania danych z pamięci podręcznej, użyje domyślnie bazy danych sqlite. Plik w skrypcie przykładowym ma nazwę db.sqlite3 i znajduje się w tym samym katalogu folderu RESTBase. Jeśli chcesz uruchomić RESTBase jako usługę później, będziesz mógł umieścić bazę danych w innym folderze, w którym użytkownik uruchamiający usługę miałby uprawnienia do zapisu. W tym celu możesz zmienić linię na:  (oraz mieć zapewnienie, że konto użytkownika, na którym działa usługa, ma uprawnienia do pisania na nim). Please note: You must manually add   parameter since they introduced storage groups for SQLite (see 225579).


 * In MediaWiki 1.35 and later you need to call Parsoid via your  file in case the  is not installed for the wiki:

Jeśli chcesz obsługiwać żądania z wielu stron wiki na tym samym serwerze RESTBase, powinieneś skopiować i powtórzyć całą sekcję, w razie potrzeby zmieniając konfigurację.



Uruchom serwer i przetestuj
Aby przetestować, czy działa, w folderze RESTbase uruchom:

Do testowania, gdy jest uruchomiony, na innym terminalu wykonaj:

Powinieneś zobaczyć zawartość HTML strony głównej.

W przeglądarce możesz także przetestować, przechodząc do np. http://localhost:7231/v1/ powinieneś zobaczyć stronę zatytułowaną Wikimedia REST API. Na tej stronie możesz przetestować wszystkie metody i zmienne RESTBase.

W przypadku innych testów patrz GitHub.



Jeśli port RESTBase jest zablokowany
Jeśli nie widzisz strony (Twoja przeglądarka mówi, że nie może się połączyć), Twój port serwera RESTBase może być zablokowany. Wykonaj następujące czynności:


 * Jeśli dostaniesz, Twój port serwera RESTBase jest ok.
 * Jeśli nie dostałeś, następnie zrób:
 * Jeśli dostaniesz  serwer RESTBase nie jest zły, ale nie możesz uzyskać dostępu do portu.

Aby ominąć blokadę, możesz ustawić proxypass na konfiguracji httpd swojego Apache. Zobacz sekcję Proxy prosi o RESTBase z twojego serwera WWW instrukcji.



Automatyczne uruchamianie serwera RESTBase
Utwórz nowego użytkownika dla usługi RESTBase (opcjonalnie, ale zaleca się, aby nie uruchamiać go jako root) i utworzyć katalog domowy dla tego użytkownika:

Do instalowania serwera RESTBase jako usługi z systemd, utwórz ten plik w katalogu , ($3 dla CentOS 7 i $4 dla openSUSE) i nazwij go $5.

Zastąp  ścieżką do katalogu projektu twojej bazy.

Aby automatycznie uruchomić serwer RESTBase podczas uruchamiania systemu,

Aby kontrolować serwer RESTBase,



Proxy prosi o RESTBase z twojego serwera WWW
Aby niektóre funkcje działały poprawnie, RESTBase musi być dostępny dla użytkowników witryny. Posiadanie RESTBase na niestandardowym porcie http jest problematyczne dla niektórych użytkowników za firmowym proxy lub zaporą. Aby rozwiązać ten problem, a szczególnie w celu obsługi zgłoszeń do RESTBase za pośrednictwem protokołu HTTPS, powinieneś skonfigurować serwer proxy odwrotnego zapisu na swoim serwerze WWW, który przekierowałby żądania w danej ścieżce Twojej wiki do serwera RESTBase.

Apache
Jeśli używasz Apache, możesz zrobić plik  i umieścić w   z.

Nginx
W ogólnej konfiguracji:

W środku bloku :

{{#tag:syntaxhighlight| {{tmpl|0= location /$1/v1/ {
 * 1) Alternate configuration like WMF to have URLS like //example.com/api/rest_v1/
 * 2) location /api/rest_v1/ {

proxy_pass http://restbase/$1/v1/$restbasequery; } }} }}
 * 1 = TWOJA_STRONA_WIKI
 * lang = "nginx"

Configuring config.yaml for WMF like URLS
If you don't want to get a fetch error when using WMF like URLS, you should add  to the   module like so:

Testowanie
Powinieneś ponownie uruchomić httpd (kodem  lub w jakiś sposób). Teraz przeglądarce możesz nawigować do:

(alternatywny adres URL, np. konfiguracja WMF):

powinieneś zobaczyć stronę zatytułowaną Wikimedia REST API. I w tym ustawieniu powinieneś dodać poniżej  dla.

