HedgeDoc - wspólna edycja dokumentów Markdown w czasie rzeczywistym. Kilka osób pracuje jednocześnie nad tym samym dokumentem i widzi zmiany innych na bieżąco.
Środowisko
| Runtime | Oficjalny obraz Docker quay.io/hedgedoc/hedgedoc, własny kontener PostgreSQL w komplecie, nginx Boxa jako reverse proxy (w tym websocket realtime) |
| Zalecany plan | Box M+ (Docker, aplikacja + własna baza Postgres, min 1 GB RAM) |
Przykładowy saplo.yaml
Plik saplo.yaml w katalogu głównym repozytorium opisuje, jak Saplo ma zbudować i uruchomić aplikację. Wygeneruje go też komenda saplo init.
version: 1
name: nasze-notatki
stack: hedgedoc
app_id: 1234
Pełny opis wszystkich pól znajdziesz na stronie Plik saplo.yaml.
Jak wdrożyć
Ten stack wdrożysz na trzy sposoby - wybierz wygodny dla siebie:
- Z panelu - tworzysz aplikację klikami, kod wgrywasz później przez CLI lub Git.
- Saplo CLI - z katalogu projektu:
saplo init, potemsaplo deploy. - Deploy z GitHub - podłączasz repo raz, każdy push wdraża się sam.
# Najszybsza droga - z katalogu projektu
$ npm install -g @saplo/cli
$ saplo login
$ saplo init
$ saplo deploy
Dobrze wiedzieć
- Stawiasz z panelu jednym kliknięciem - Saplo instaluje Docker CE, pobiera obrazy i uruchamia kontenery.
- Własny Postgres w osobnym kontenerze - HedgeDoc wymaga bazy SQL, więc nie korzysta ze współdzielonej bazy Saplo (dostępna tylko dla MySQL/MariaDB).
- Brak osobnego konta administratora - każdy, kto się zarejestruje, jest zwykłym użytkownikiem i widzi własne dokumenty oraz te, do których dostał link. Pierwsze konto zakładasz sam w kreatorze przy pierwszym wejściu na stronę.
- Wspólna edycja działa przez websocket na tej samej domenie aplikacji - widzisz kursory i zmiany innych uczestników na żywo, bez dodatkowej konfiguracji.
- Inna nisza niż Trilium (notatnik jednej osoby) i Wiki.js/BookStack (oba w katalogu, wiki firmowe z wersjonowaniem stron) - HedgeDoc skupia się na żywej, jednoczesnej edycji pojedynczego dokumentu, nie na strukturze i uprawnieniach całej bazy wiedzy.
- Kopia (automatyczna od Box L, ręcznie snapshotem na każdym planie) obejmuje wolumen z załącznikami oraz bazę danych z treścią wszystkich dokumentów.
Gotowy na deploy?
Wybierz plan Box i postaw aplikację HedgeDoc jeszcze dziś.