Krótki przewodnik po konfiguracji własnej Wiki z Wiki.js w zaledwie kilka minut

Wiki.js to bogata w funkcje, otwartoźródłowa aplikacja wiki oparta na frameworku Node.js. Oferuje wszechstronne środowisko edycji, obsługując zarówno interfejsy Markdown, jak i WYSIWYG. Dodatkowo, umożliwia współpracę w czasie rzeczywistym, kontrolę wersji oraz różnorodne metody uwierzytelniania, w tym integrację z Google i LDAP. Ten kompleksowy przewodnik przeprowadzi Cię przez niezbędne kroki konfiguracji Wiki.js z Dockerem, umożliwiając wdrożenie własnej wiki w zaledwie kilka minut.

Konfigurowanie Wiki.js za pomocą Docker Compose

Proces konfiguracji Wiki.js z wykorzystaniem Dockera i Docker Compose jest prosty. Zacznij od utworzenia nowego katalogu o nazwie wikijs-dockeri przejdź do niego:

mkdir wikijs-docker && cd wikijs-docker

Następnie utwórz plik o nazwie, docker-compose.ymlkorzystając z preferowanego edytora tekstu:

nano docker-compose.yml

Następnie wstaw następującą konfigurację do pliku:

services: db: image: postgres:16 environment: POSTGRES_DB: wiki POSTGRES_PASSWORD: wikijsrocks POSTGRES_USER: wikijs restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data wiki: image: ghcr.io/requarks/wiki:2 depends_on: - db environment: DB_TYPE: postgres DB_HOST: db DB_PORT: 5432 DB_USER: wikijs DB_PASS: wikijsrocks DB_NAME: wiki restart: unless-stopped ports: - "80:3000" volumes: db-data:

Po zapisaniu i zamknięciu pliku zainicjuj kontenery, wykonując następujące polecenie:

docker compose up -d

Po zakończeniu procesu instalacji przejdź do adresu http://localhost w przeglądarce internetowej. W tym miejscu należy podać dane konta administratora i kliknąć przycisk „Instaluj”, aby rozpocząć instalację:

Po zakończeniu instalacji zaloguj się, używając swoich danych logowania.

Tworzenie i zarządzanie stronami w Wiki.js

Po zakończeniu konfiguracji początkowej możesz utworzyć stronę główną i rozpocząć wprowadzanie treści lub uzyskać dostęp do panelu administracyjnego, aby zarządzać ustawieniami, użytkownikami i dostępnymi funkcjami:

Po kliknięciu opcji Utwórz stronę główną zostaniesz poproszony o wybranie edytora dostosowanego do Twoich preferencji:

Następnie zdefiniuj właściwości swojej strony i kliknij przycisk OK, aby kontynuować tworzenie nowej strony:

Wpisz żądaną treść i kliknij przycisk Utwórz, aby zakończyć tworzenie strony:

Zarządzanie i organizowanie treści

Twój panel zapewnia wygodny sposób przeglądania i modyfikowania istniejących stron, a także tworzenia nowych za pomocą wybranego edytora. Możesz organizować swoją zawartość, zmieniając nazwy, przenosząc lub usuwając strony, a także korzystać z tagów do efektywnej kategoryzacji. Dodatkowo, pasek boczny i funkcja wyszukiwania przyspieszają nawigację do konkretnych stron w Twojej wiki:

Konfigurowanie ustawień witryny Wiki.js

W panelu administracyjnym Wiki.js masz możliwość elastycznej konfiguracji ustawień witryny, takich jak ustawienia regionalne, struktury nawigacji, motywy i tagi. Ustawienia te odgrywają kluczową rolę w definiowaniu ogólnej konfiguracji Twojej instancji Wiki.js.

Na karcie Ogólne możesz dostosować podstawowe ustawienia witryny, w tym tytuł witryny, opis, domyślną stronę główną i ustawienia widoczności (publiczna lub prywatna):

Przejdź do karty Ustawienia regionalne, aby określić domyślny język, strefę czasową i formaty daty/godziny dla swojej witryny:

Aby zarządzać strukturą menu swojej wiki i usprawnić nawigację użytkownika, przejdź do sekcji Pasek nawigacyjny :

Na karcie Strony możesz nadzorować, edytować i organizować wszystkie strony wiki, tworzyć nowe strony i zarządzać hierarchią swojej zawartości:

Ponadto, w zakładce „Tagi” możesz tworzyć i zarządzać tagami treści, co usprawnia wyszukiwanie na stronie. Możesz również dostosować elementy estetyczne swojej wiki za pomocą zakładki „Motyw”, gdzie możesz zmienić logo witryny, kolory, czcionki i style układu.

Zarządzanie grupami w Twojej Wiki

Sekcja „Grupy” umożliwia tworzenie grup użytkowników, wyznaczanie członków i ustalanie uprawnień na poziomie grupy w celu regulacji dostępu. Ta metoda organizacji pomaga usprawnić role użytkowników i zapewnia spójne zarządzanie dostępem w całej wiki.

Kliknięcie na konkretną grupę umożliwia aktualizację jej ustawień, uprawnień, reguł strony i zarządzanie użytkownikami w ramach tej grupy. Na karcie Ustawienia możesz dostosować opcje, w tym adres URL przekierowania logowania.

Możesz także poruszać się po sekcjach Uprawnienia, Zasady strony i Użytkownicy, aby doprecyzować, do czego grupa ma mieć dostęp, i odpowiednio przypisać użytkowników.

Zarządzanie użytkownikami w Wiki.js

Aby dodać nowego użytkownika, przejdź do sekcji Użytkownicy, kliknij przycisk NOWY UŻYTKOWNIK i wypełnij wymagane pola.

Po zakończeniu wybierz opcję UTWÓRZ lub UTWÓRZ I ZAMKNIJ, aby zakończyć konfigurację nowego użytkownika:

Wybranie konkretnego użytkownika umożliwia przeglądanie i edytowanie jego profilu, przypisywanie grup użytkowników, definiowanie metod uwierzytelniania (takich jak hasła lub uwierzytelnianie dwuskładnikowe) oraz zarządzanie jego statusem za pomocą akcji takich jak Dezaktywuj, Zweryfikuj lub Usuń :

Dodatkowo możesz aktualizować ich podstawowe informacje, rozszerzone metadane (w tym lokalizację i stanowisko) oraz przeglądać historię ich aktywności:

Zarządzanie modułami Wiki

Moduły to rozszerzenia, które zwiększają możliwości Wiki.js. Na przykład moduł Analytics umożliwia integrację narzędzi takich jak Google Analytics, aby śledzić zaangażowanie użytkowników i metryki ruchu:

Karta Uwierzytelnianie umożliwia skonfigurowanie i zarządzanie dostawcami uwierzytelniania (logowanie lokalne, LDAP, OAuth) oraz skonfigurowanie różnych opcji logowania:

Możesz także włączać i wyłączać system komentarzy oraz określać, w jaki sposób użytkownicy angażują się w dyskusje na stronie:

Konfiguracja systemu

Zarządzaj sposobem renderowania, indeksowania i przechowywania treści, konfigurując silniki renderujące, indeksowanie wyszukiwania i ustawienia pamięci masowej. Na przykład, przejdź do karty Renderowanie, aby dostosować renderowanie treści, na przykład dostosowując ustawienia silnika Markdown lub włączając obsługę diagramów i wyrażeń matematycznych:

W sekcji Wyszukiwarka możesz zarządzać opcjami indeksowania wyszukiwania wewnętrznego i integracją z wyszukiwarkami innych firm:

W sekcji Pamięć masowa określ cele tworzenia kopii zapasowych i synchronizacji treści, co umożliwi Ci zarządzanie miejscem i sposobem przechowywania multimediów oraz załączników do stron (np.w lokalnym systemie plików lub w usłudze AWS S3):

Zarządzanie bezpieczeństwem i łącznością

Możesz zabezpieczyć swoją instancję Wiki.js, konfigurując dostęp do API, ustawiając powiadomienia e-mail, dostosowując zasady bezpieczeństwa i włączając protokół SSL, aby zapewnić sobie bezpieczeństwo. Na przykład, obsługuj tokeny API, aby zintegrować Wiki.js z innymi aplikacjami:

Skonfiguruj konfigurację poczty e-mail w celu zarządzania powiadomieniami, zaproszeniami i procesami odzyskiwania hasła w Wiki.js:

Ustawienia zabezpieczeń można również dostosować do własnych potrzeb, uwzględniając takie kwestie jak limity czasu sesji, zasady dotyczące haseł i ograniczenia dostępu:

Co więcej, możesz skonfigurować certyfikaty SSL/TLS, aby mieć pewność, że Twoja instancja Wiki.js będzie działać bezpiecznie przez protokół HTTPS:

Dodatkowo sprawdź informacje w Wiki, takie jak diagnostyka systemu, specyfikacje serwera i statystyki środowiska wykonawczego w sekcji Informacje o systemie :

Wykonaj czynności konserwacyjne, takie jak ponowne indeksowanie wyników wyszukiwania, czyszczenie danych z pamięci podręcznej lub resetowanie konfiguracji, z poziomu karty Narzędzia :

Na koniec, Narzędzia programistyczne oferują zaawansowane zasoby, takie jak GraphQL Playground, możliwości debugowania logów czy integracje z niestandardowymi skryptami:

Teraz, gdy posiadasz wiedzę niezbędną do skonfigurowania Wiki.js przy użyciu Dockera, możesz śmiało używać tej platformy do łatwego tworzenia dokumentacji wewnętrznej, wiki zespołów współpracujących ze sobą lub publicznych baz wiedzy.

Źródło i obrazy