Mikä on ääriviivat?
Outline on moderni, yhteistyöhön perustuva tietokanta ja dokumentointialusta, joka on suunniteltu auttamaan tiimejä luomaan, järjestämään ja jakamaan tietoa keskitetyssä työtilassa.
Se tarjoaa jäsennellyn asiakirjaympäristön, jossa käyttäjät voivat kirjoittaa teknistä dokumentaatiota, sisäisiä käsikirjoja, perehdytysoppaita, vakiokäytäntöjä, projektimuistiinpanoja ja organisaation tietoja.
Outline yhdistää rikkaan tekstieditorin Markdown-tuella, sisäkkäisillä asiakirjoilla, kokoelmilla, kokotekstihaulla ja reaaliaikaisella yhteismuokkauksella.
Sen käyttöliittymän avulla tiimit voivat helposti ylläpitää jaettua dokumentaatiota ja hallita samalla, kuka voi käyttää, muokata ja hallita yksittäisiä asiakirjoja ja kokoelmia.
Alusta tarjoaa myös integraatioita, ohjelmointirajapintoja ja todennusvaihtoehtoja, joiden avulla organisaatiot voivat yhdistää tietopohjansa olemassa olevaan infrastruktuuriin.
Outline sopii erityisen hyvin kehitystiimeille, yrityksille, IT-osastoille ja organisaatioille, jotka tarvitsevat keskitetyn sijainnin sisäisen dokumentaation ylläpitoon.
Ääriviivojen historia
Outline luotiin tarjoamaan tiimeille moderni vaihtoehto perinteisille wiki- ja dokumentaatioalustoille.
Projekti keskittyy tekemään dokumentaatiosta saavutettavaa, yhteistyökykyistä ja helposti ylläpidettävää puhtaan käyttöliittymän ja jäsennellyn dokumenttien organisoinnin avulla.
Ensisijaisesti TypeScriptillä, Reactilla ja Node.js: llä rakennettu Outline yhdistää verkkopohjaisen sovelluksen tausta-arkkitehtuuriin, joka on suunniteltu tukemaan yhteistyömuokkausta ja skaalautuvia käyttöönottoja.
Projekti on kehittynyt sisältämään asiakirjakokoelmia, reaaliaikaista yhteistyötä, käyttöoikeuksia, integraatioita, hakua ja API-toimintoja.
Outline on saatavilla isännöitynä palveluna ja itse isännöitävänä käyttöönotona.
Lisenssihuomautus: Nykyinen lähdekoodivarasto käyttää Business Source License 1.1 (BSL 1.1) -lisenssiä, joka on lähdekoodin saatavilla oleva eikä OSI: n hyväksymä avoimen lähdekoodin lisenssi. Lisenssi sisältää ylimääräisiä käyttörajoituksia, jotka koskevat erityisesti kolmansien osapuolten asiakirjapalveluita. Tutustu lisenssiehtoihin ennen kuin käytät Outlinea kaupallisena isännöitynä palveluna.
Ääriviivojen tärkeimmät ominaisuudet
Outline tarjoaa kattavan joukon työkaluja organisaation dokumentaation luomiseen ja hallintaan.
- Collaborative Document Editor: Luo ja muokkaa asiakirjoja käyttämällä moderni rich text editor.
- Real-Time Collaboration: Salli useiden käyttäjien työstää asiakirjoja samanaikaisesti.
- Asiakirjakokoelmat: Järjestä dokumentaatio jäsenneltyihin kokoelmiin.
- Sisäkkäiset asiakirjat: Luo hierarkkisia asiakirjarakenteita monimutkaisille aiheille.
- Markdown-tuki: Kirjoita ja muotoile dokumentaatio Markdownin avulla.
- Kokotekstihaku: Etsi nopeasti tietoja eri asiakirjoista ja kokoelmista.
- Asiakirjan käyttöoikeudet: Hallitse kuka voi tarkastella ja muokata dokumentaatiota.
- Käyttäjien hallinta: Järjestä työtilan jäsenet ja hallitse käyttöoikeuksia.
- Kommentit ja maininnat: Keskustele dokumentaatiosta ja ilmoita tiimin jäsenille.
- Asiakirjan historia: Tarkastele aiempia asiakirjan tarkistuksia ja muutoksia, jos versio tukee niitä.
- Mallit: Luo uudelleenkäytettäviä asiakirjarakenteita.
- Liitetiedostot: Lataa kuvia ja muita tiedostoja dokumentaatioon.
- Tuonti ja vienti: Siirrä dokumentaatiota alustalle ja pois alustalta tuettujen formaattien avulla.
- API Access: Integroi Outline ulkoisten sovellusten ja automatisoitujen työnkulkujen kanssa.
- Ulkoinen todennus: Tukee todennusta palveluntarjoajien, kuten Googlen, Microsoftin, Slackin ja yhteensopivien tunnistetietojen tarjoajien kautta.
- Integraatiot: Yhdistä dokumentoinnin työnkulut ulkoisiin palveluihin.
- Mukautettava työtila: Määritä työtilan asetukset ja dokumentaation organisointi.
- Docker-käyttöönotto: Isännöi sovellusta Dockerin ja Docker Composen avulla.
Esimerkkejä käytöstä
Outline sopii organisaatioille ja tiimeille, jotka tarvitsevat keskitetyn tiedonhallinta-alustan.
Yleisiä käyttötapauksia ovat:
- Sisäinen dokumentaatio: Ylläpitää yrityksen käytäntöjä, menettelyjä ja toiminnallista dokumentaatiota.
- Tekninen dokumentaatio: Dokumentoi infrastruktuuri, ohjelmointirajapinnat, ohjelmistoarkkitehtuuri ja kehitysprosessit.
- IT-tietokanta: Järjestä palvelinkonfiguraatiot, verkkodokumentaatio, vianmääritystoimenpiteet ja käyttöoppaat.
- Työntekijöiden perehdytys: Luo perehdytysmateriaaleja, työntekijöiden käsikirjoja ja koulutusdokumentaatiota.
- Kehitystiimit: Ylläpidä koodausstandardeja, käyttöönotto-ohjeita ja kehitysohjeita.
- Projektin dokumentointi: Järjestä projektin vaatimukset, tekniset tiedot ja toteutus muistiinpanoja.
- Asiakastuki: Ylläpidä sisäisiä tukioppaita ja vianmääritysdokumentaatiota.
- Standard Operating Procedures: Dokumentoi toistuvat liiketoimintaprosessit ja operatiiviset työnkulut.
- Team Collaboration: Jaa tietoa eri osastoilla ja organisaatioyksiköissä.
- Järjestelmänhallinta: Ylläpitää infrastruktuurin inventointeja, kokoonpanoviitteitä ja tapausmenettelyjä.
Ääriviivojen hyödyt
- Keskitetty tiedonhallinta tiimeille
- Moderni ja intuitiivinen dokumentointikäyttöliittymä
- Reaaliaikainen yhteismuokkaus
- Rakenteelliset kokoelmat ja sisäkkäiset dokumentit
- Tehokas kokotekstihaku
- Markdown-yhteensopiva dokumentaatio
- Konfiguroitavat käyttöoikeudet
- Ulkoiset todennusintegraatiot
- API-pääsy automaatioon ja integraatioihin
- Tiedostoliitteet ja upotettu sisältö
- Docker-pohjainen itseisännöity käyttöönotto
- Dokumentaation ja infrastruktuurin parempi hallinta
Kuinka asentaa Outline
Asenna Outline Esadaxin kautta noudattamalla seuraavia ohjeita:
- Osta sovellus Esadaxin kautta.
- Oston jälkeen sinua pyydetään antamaan tarvittavat kokoonpanoparametrit.
- Anna julkisen sovelluksen URL-osoite ja tietokantayhteyden tiedot.
- Määritä Redis välimuistiin ja sovelluspalveluihin.
- Määritä tarvittavat suojaussalaisuudet.
- Valitse asiakirjaliitteille paikallinen tai S3-yhteensopiva tallennustila.
- Määritä todennuspalvelu, kuten OIDC, Google, Microsoft tai jokin muu tuettu vaihtoehto.
- Käynnistä sovellus valitsemalla Ota käyttöön.
- Käytä Outlinea sille määritetyn sovellus-URL-osoitteen kautta.
- Suorita ensimmäinen todennus ja työtilan määritys loppuun.
- Luo ensimmäinen asiakirjakokoelma.
- Kutsu tiimin jäseniä ja määritä käyttöoikeudet.
- Aloita dokumentaatiosi luominen ja järjestäminen.
Kun Outline on määritetty, se tarjoaa keskitetyn ympäristön organisaation tiedon hallintaan ja jakamiseen.
Asiakirjojen hallintajärjestelmät
Asiakirjat ovat Outlinen ensisijaisia rakennuspalikoita.
Käyttäjät voivat luoda sivuja, jotka sisältävät muotoiltua tekstiä, otsikoita, luetteloita, taulukoita, kuvia, linkkejä, koodilohkoja ja muuta tuettua sisältöä.
Asiakirjat voidaan järjestää kokoelmiin ja sisäkkäisiin hierarkioihin.
Esimerkiksi IT-osasto saattaa järjestää tietopohjansa seuraavasti:
- Infrastruktuuri
- ProxmoxName
- Verkostoituminen
- Varastointi
- Varmuuskopiointimenettelyt
- Kehitys
- Ohjelmointirajapinnan dokumentaatio
- Koodausstandardit
- Deployment Guides (englanniksi)
- Turvallisuus
- Käyttöoikeuksien hallinta
- Incident Response -palvelut
- Tietoturvakäytännöt
- Toiminnot
- Seuranta
- Ylläpito
- Vianmääritys
Tämä rakenne helpottaa dokumentaation ylläpitoa ja tiedon paikantamista tietopohjan kasvaessa.
Asiakirjoja voidaan päivittää jatkuvasti järjestelmien, prosessien ja organisaation vaatimusten muuttuessa.
Kokoelmat ja organisaatio
Jäsennys käyttää kokoelmia järjestääkseen toisiinsa liittyvät asiakirjat loogisiin ryhmiin.
Kokoelma voi edustaa osastoa, projektia, teknistä aihetta tai mitä tahansa muuta dokumentaatioluokkaa.
Järjestelmänvalvojat ja valtuutetut käyttäjät voivat luoda kokoelmia ja määrittää niiden käyttöoikeudet.
Tyypillisiä keräysrakenteita ovat mm.
- Yrityksen dokumentaatio
- Tekniikka
- Infrastruktuuri
- Henkilöstöhallinnon palvelut
- 24/7 asiakastuki
- Tuotedokumentaation lataaminen
- Sisäiset menettelyt
- Projektiosaamisen kehittäminen
Kokoelmat auttavat erottamaan organisaation tiedon eri osa-alueet ja pitämään kaiken käytettävissä yhden työtilan kautta.
Asiakirjoja voidaan myös sijoittaa sisäkkäin muiden asiakirjojen sisään, jotta voidaan luoda yksityiskohtaisempia tietohierarkioita.
Yhteistyöllä toimiva asiakirjaeditori
Outline sisältää rikkaan tekstieditorin, joka on suunniteltu dokumentaation luomiseen ja ylläpitämiseen.
Käyttäjät voivat kirjoittaa sisältöä ilman manuaalista HTML-muotoilua tai asiakirjatiedostojen hallintaa.
Toimittaja tukee:
- Otsikot ja kappaleet
- Markdown-muotoilu
- Luettelomerkityt ja numeroidut luettelot
- Taulukot
- Koodilohkot
- Kuvat ja liitteet
- Linkit ja upotettu sisältö
- Lainaukset ja selitteet
- Tarkistuslistat
- Tekstin muotoilu ja inline-elementit
Toimittaja tukee myös reaaliaikaista yhteistyötä, jolloin useat tiimin jäsenet voivat työskennellä saman asiakirjan parissa.
Muutokset synkronoidaan yhdistettyjen käyttäjien välillä, mikä helpottaa yhteistyötä teknisten oppaiden, menettelytapojen ja jaettujen asiakirjojen parissa.
Tämä on erityisen hyödyllistä ylläpidettäessä dokumentaatiota, joka edellyttää useiden osastojen tai osallistujien panosta.
Haku ja tiedonhaku
Outline tarjoaa kokotekstihakutoiminnon, jolla voi etsiä tietoja koko tietokannasta.
Sen sijaan, että käyttäjät navigoisivat manuaalisesti kokoelmissa ja sisäkkäisillä sivuilla, he voivat etsiä avainsanoja ja asiaankuuluvaa dokumentaatiota.
Haku on hyödyllinen löytääksesi:
- Tekniset menettelyt
- Infrastruktuurin kokoonpanot
- Vianmääritysohjeet
- Sisäiset käytännöt
- Hankkeen dokumentointi
- API-viittaukset (englanniksi)
- Työntekijöiden perehdytysmateriaalit
Hyvin järjestetty tietokanta yhdistettynä tehokkaaseen hakuun vähentää tiedon löytämiseen kuluvaa aikaa.
Tiimit voivat käyttää Outlinea operatiivisen ja teknisen tiedon keskitettynä viitejärjestelmänä.
Käyttäjien hallinta ja käyttöoikeudet
Outline tarjoaa käyttäjä- ja käyttöoikeuksien hallintatoiminnot työtilaan osallistumisen hallintaan.
Työtilan järjestelmänvalvojat voivat hallita jäseniä ja määrittää heille sopivia rooleja.
Painoksesta ja määritetyistä käyttöoikeuksista riippuen käyttöä voidaan hallita seuraavien kautta:
- Työtilan jäsenyys
- Käyttäjän roolit
- Kokoelman käyttöoikeudet
- Asiakirjan käyttöoikeusasetukset
- Pääsy vieraille
- Järjestelmänvalvojan oikeudet
Näin organisaatiot voivat ylläpitää erilaisia käyttöoikeuksia työntekijöille, esimiehille, järjestelmänvalvojille ja ulkoisille yhteistyökumppaneille.
Esimerkiksi tekninen dokumentaatio voidaan jakaa insinööritiimeille, kun taas HR-dokumentaatio pysyy vain valtuutetun henkilöstön käytettävissä.
Outline tukee myös tunnistautumista ulkoisten tunnistetietojen toimittajien kautta sen sijaan, että se ylläpitäisi omaa perinteistä sähköposti- ja salasanatunnistusjärjestelmää.
Todennus ja kertakirjautuminen
Outline tukee useita todennusmenetelmiä, joilla käyttäjät voidaan yhdistää olemassa olevaan tunnistetietojen toimittajaan.
Tuetut todennusvaihtoehdot ovat seuraavat:
- Google-todennus
- Microsoft-todennus
- Slack-tunnistautuminen
- Sähköpostipohjainen kirjautuminen vahvistuslinkkien tai -koodien avulla
- OpenID-yhteys (OIDC)
- SAML-todennus lisensoiduissa versioissa
Yksittäisten todennusmenetelmien saatavuus riippuu valitusta versiosta.
Itse isännöidyissä asennuksissa on määritettävä todennuspalveluntarjoaja, ennen kuin käyttäjät voivat kirjautua sisään.
Outline ei tallenna perinteisiä käyttäjäsalasanoja. Todennus hoidetaan yhdistettyjen palveluntarjoajien, tuettujen tunnusten tai sähköpostitse lähetettävien kirjautumislinkkien ja vahvistuskoodien avulla.
Tämä tekee integraatiosta olemassa olevan identiteetinhallintajärjestelmän kanssa erityisen hyödyllisen organisaatioille, jotka käyttävät jo keskitettyä todennusta.
Integraatiot ja API
Outline tarjoaa integraatiomahdollisuuksia, joiden avulla tietokanta voi toimia muiden liiketoiminta- ja kehitystyökalujen rinnalla.
Sen REST API mahdollistaa ulkoisten sovellusten vuorovaikutuksen asiakirjojen, kokoelmien, käyttäjien ja muiden tuettujen resurssien kanssa.
Yleisiä integrointiskenaarioita ovat:
- Dokumentaation luominen automaattisesti.
- Asiakirjojen hakeminen ulkoisia sovelluksia varten.
- Tietojen synkronointi järjestelmien välillä.
- Sisäisten kehittäjätyökalujen integrointi.
- Mukautettujen dokumentointirajapintojen rakentaminen.
- Tietohallinnon tehtävien automatisointi.
- Dokumentointityönkulkujen yhdistäminen ulkoisiin palveluihin.
Outline tarjoaa myös integraatioita Slackin kaltaisten alustojen kanssa, jolloin tiimit voivat käyttää dokumentaatiota ja vastaanottaa asiaankuuluvia ilmoituksia nykyisten viestintätyökalujensa kautta.
API-todennus käyttää määritettyjä API-tunnistetietoja ja asianmukaisia käyttöoikeuksia.
Tiedostojen liitteet ja tallennus
Outline tukee tiedostojen lataamista ja kuvien ja muiden liitteiden upottamista asiakirjoihin.
Tiedostot voidaan tallentaa paikallisesti sovelluspalvelimelle tai S3-yhteensopivan objektitallennuspalvelun kautta.
Tuetut tallennuskokoonpanot ovat:
- Paikallisen tiedostojärjestelmän tallennus
- Amazon S3 -palvelu
- MinIO
- Muut yhteensopivat objektitallennuspalvelut, joita määritetty S3 API tukee
Paikallinen tallennustila sopii suoraviivaisiin käyttöönottoihin, joissa tiedostoja ylläpidetään sovellusinfrastruktuurin rinnalla.
S3-yhteensopiva tallennustila on hyödyllinen suuremmissa asennuksissa, hajautetuissa ympäristöissä ja käyttöönotoissa, jotka edellyttävät riippumatonta objektitallennustilaa.
Luotettavaa toimintaa varten:
- Määritä pysyvä tallennustila paikallisille liitteille.
- Käytä sopivaa objektitallennussäiliötä, kun käytät S3: ta.
- Määritä latauskokorajoitukset.
- Suojaa tallennusvaltuudet.
- Sisällytä liitteet varmuuskopiointimenettelyihin.
- Tarkista tallennusoikeudet ja käyttökäytännöt.
Haku, kommentit ja ilmoitukset
Outline tarjoaa yhteistyötoimintoja asiakirjojen muokkauksen lisäksi.
Kommenttien avulla ryhmän jäsenet voivat keskustella asiakirjan sisällöstä ja antaa palautetta.
Maininnoilla voidaan ilmoittaa tietyille käyttäjille, kun heidän huomiotaan tarvitaan.
Nämä ominaisuudet ovat hyödyllisiä:
- Teknisen dokumentaation tarkastelu
- Menettelyjen päivitysten pyytäminen
- Keskustelu toteutuksen yksityiskohdista
- Dokumentaatiomuutosten koordinointi
- Onboarding-materiaalien tarkastelu
- Tiedon jakaminen osastojen välillä
Ilmoitusten toimitus riippuu määritetyistä sovellusintegraatioista ja sähköpostiasetuksista.
Tietoturva / ylläpito / konfigurointi
Koska Jäsennys tallentaa sisäistä dokumentaatiota ja mahdollisesti arkaluontoisia organisaatiotietoja, se tulisi ottaa käyttöön asianmukaisilla tietoturvaominaisuuksilla.
Tärkeitä turvallisuuskäytäntöjä ovat:
- Käytä vahvoja ja satunnaisesti luotuja sovellussalaisuuksia.
- Ota HTTPS käyttöön kaikessa ulkoisessa käytössä.
- Määritä hyväksytty todennuspalveluntarjoaja.
- Rajoita käyttöoikeudet valtuutetuille työtilan jäsenille.
- Määritä kokoelman käyttöoikeudet huolellisesti.
- Suojaa PostgreSQL- ja Redis-palvelut.
- Rajoita tietokantaportit luotettuun infrastruktuuriin.
- Suojaa API-tunnistetiedot.
- Määritä pysyvä ja turvallinen tiedostojen tallennustila.
- Pidä sovelluskuvat ja riippuvuudet ajan tasalla.
- Varmuuskopioi tietokanta ja ladatut liitteet säännöllisesti.
- Tarkista järjestelmänvalvojan käyttöoikeudet säännöllisesti.
- Vältä sisäisen dokumentaation paljastumista julkisesti saatavilla olevien kokoelmien kautta.
Outline tukee myös tiedostopohjaisia salaisuuksia Docker-käyttöönottoja varten. Herkkiä ympäristömuuttujia voidaan toimittaa Docker-salaisuuksien kautta käyttämällä vastaavaa _FILE-määritysmuuttujaa.
Säilytä tuotantokäyttöönottoja varten turvalliset kopiot kaikista salaus- ja sovellussalaisuuksista. Näiden arvojen menettäminen voi vaikuttaa kykyyn purkaa aiemmin suojattujen tietojen salaus.
Jäsennyksen parhaat käytännöt
- Järjestä asiakirjat merkityksellisiksi kokoelmiksi.
- Käytä kuvaavia asiakirjan otsikoita.
- Luo johdonmukaiset dokumentointistandardit.
- Luo uudelleenkäytettäviä asiakirjamalleja.
- Määritä keräysoikeudet tiimin vastuiden mukaan.
- Tarkista ja päivitä dokumentaatio säännöllisesti.
- Käytä kommentteja ja mainintoja muutosten koordinointiin.
- Pidä tekninen dokumentaatio linjassa todellisen infrastruktuurin kanssa.
- Integroi todennus olemassa olevan tunnistetietojen toimittajan kanssa.
- Määritä HTTPS ulkoista käyttöä varten.
- Käytä pysyvää tallennustilaa liitteille.
- Varmuuskopioi PostgreSQL ja ladatut tiedostot.
- Suojaa sovellussalaisuudet ja API-tunnistetiedot.
- Kiinnitä sovellusversiot sen sijaan, että luottaisit pätemättömiin uusimpiin tunnisteisiin.
- Testaa sovelluspäivitykset ennen niiden käyttöönottoa tuotannossa.
Määritysparametrit
Kun olet ostanut tämän sovelluksen Esadax, sinua pyydetään antamaan käyttöönoton edellyttämät kokoonpanoparametrit.
Esadax lisää toimitetut muuttujat käyttöönottoon, jotta sovellus voidaan käynnistää sen vaatimalla kokoonpanolla.
Outline tukee konfigurointia ympäristömuuttujien tai Docker-ympäristötiedoston kautta.
Seuraavia muuttujia pidetään vähimmäiskokoonpanona tavalliselle itse isännöidylle asennukselle:
| Parametri | Kuvaus |
|---|---|
URL |
Täydellinen julkinen URL-osoite, jota käytetään Outline-asennuksen käyttämiseen. |
DATABASE_URL |
PostgreSQL-yhteyden URL-osoite, mukaan lukien isäntänimi, tietokannan nimi, käyttäjänimi ja salasana. |
REDIS_URL |
Redis-yhteyden URL-osoite, jota käytetään välimuistiin ja sovelluspalveluihin. |
SECRET_KEY |
Satunnaisesti luotu salasana, jota käytetään sovelluksen tietoturvaan ja salaukseen liittyviin toimintoihin. |
UTILS_SECRET |
Ylimääräinen satunnainen salaisuus, jota Outlinen hyöty- ja suojaustoiminnot käyttävät. |
PORT |
Sisäinen sovellusportti. Oletus on 3000. |
NODE_ENV |
Sovellusympäristö, tyypillisesti asetettu arvoon production. |
DEFAULT_LANGUAGE |
Oletuskäyttöliittymän kieli. |
Todennusparametrit
Vähintään yksi todentamispalvelu on määritettävä, ennen kuin käyttäjät voivat kirjautua sisään.
Valitusta palveluntarjoajasta riippuen lisämuuttujia voivat olla:
| Parametri | Kuvaus |
|---|---|
GOOGLE_CLIENT_ID |
Googlen OAuth-sovellusasiakastunnus. |
GOOGLE_CLIENT_SECRET |
Googlen OAuth-sovellussalaisuus. |
SLACK_CLIENT_ID |
Slack-sovelluksen asiakastunnus. |
SLACK_CLIENT_SECRET |
Slack-sovelluksen salaisuus. |
OIDC_CLIENT_ID |
OpenID Connect -asiakastunniste. |
OIDC_CLIENT_SECRET |
OpenID Connect -asiakkaan salasana. |
OIDC_AUTH_URI |
OpenID Connect -valtuutuspäätepiste. |
OIDC_TOKEN_URI |
OpenID Connect -tunnuksen päätepiste. |
OIDC_USERINFO_URI |
OpenID Connect -käyttäjätietojen päätepiste. |
SMTP_HOST |
SMTP-palvelimen isäntänimi sähköpostipohjaista todennusta varten. |
SMTP_PORT |
SMTP-palvelimen portti. |
SMTP_USERNAME |
SMTP-todennuksen käyttäjänimi. |
SMTP_PASSWORD |
SMTP-todennuksen salasana. |
Tiedostojen tallennusparametrit
Outline tukee paikallista tiedostojärjestelmän tallennustilaa ja S3-yhteensopivaa objektitallennustilaa.
Yleisiä kokoonpanovaihtoehtoja ovat:
| Parametri | Kuvaus |
|---|---|
FILE_STORAGE |
Säilytyksen taustajärjestelmä, joko local tai s3. |
FILE_STORAGE_LOCAL_ROOT_DIR |
Hakemisto, jota käytetään paikalliseen tiedostojen tallentamiseen. Oletus on /var/lib/outline/data. |
FILE_STORAGE_UPLOAD_MAX_SIZE |
Suurin sallittu liitetiedostokoko tavuina. |
AWS_REGION |
AWS tai yhteensopiva objektitallennusalue. |
AWS_ACCESS_KEY_ID |
Objektitallennustilan käyttöavain. |
AWS_SECRET_ACCESS_KEY |
Esinevaraston salainen avain. |
AWS_S3_UPLOAD_BUCKET_NAME |
Ämpäri, jota käytetään ladatuille tiedostoille. |
AWS_S3_UPLOAD_BUCKET_URL |
Säiliöön liittyvä julkinen tai CDN-URL-osoite. |
AWS_S3_FORCE_PATH_STYLE |
Ohjaa yhteensopivien tallennuspalveluntarjoajien polkutyyppistä osoitteenantoa. |
Lisämääritykset saattavat olla tarpeen todennuspalvelun tarjoajan, SMTP-palvelun ja valitun tallennuspalvelimen mukaan.
Tarkat määritysparametrit riippuvat Esadaxin käyttöönottopaketista. Käytä osto- ja käyttöönottoprosessin aikana esitettyjä arvoja.
Tärkeää: Luo yksilölliset satunnaisarvot arvoille SECRET_KEY ja UTILS_SECRET. Pidä ne vakaina käyttöönoton jälkeen ja tallenna varmuuskopiot turvallisesti. Niiden muuttaminen voi mitätöidä istunnot tai vaikuttaa salattujen sovellustietojen käyttöön.
Kun tarvittavat arvot on määritetty, käynnistä Outline napsauttamalla Ota käyttöön.
Tietokanta- ja infrastruktuurivaatimukset
Outline käyttää PostgreSQL: ää ensisijaisena tietokantana ja Redis: ää välimuistiin ja sovelluspalvelujen tukemiseen.
Vakiomuotoinen itseisännöity käyttöönotto sisältää tyypillisesti:
- Ääriviivasovellus: Suorittaa verkkokäyttöliittymän, ohjelmointirajapinnan, asiakirjojen hallinnan ja sovelluspalvelut.
- PostgreSQL: Tallentaa käyttäjät, dokumentit, kokoelmat, käyttöoikeudet ja sovellusten metatiedot.
- Redis: Tarjoaa välimuisti- ja tukipalveluita.
- Tiedostojen tallennus: Tallentaa asiakirjan liitteet ja ladattu media.
- Käänteinen välityspalvelin: Tarjoaa HTTPS-päättämisen ja ulkoisen pääsyn.
Virallinen Docker-käyttöönotto paljastaa Outline-sovelluksen sisäisesti porttiin 3000.
Pysyvä tallennustila on määritettävä paikallisille tiedostojen latauksille käyttämällä:
/var/lib/outline/data
Suurempiin asennuksiin voidaan sen sijaan käyttää ulkoista S3-yhteensopivaa objektitallennustilaa.
Outline on suunniteltu tukemaan horisontaalista skaalausta, mutta tuotantokäyttöönotot edellyttävät tietokannan, Redisin, tallennustilan ja yhteistyöpalveluiden huolellista määrittämistä.
Reaaliaikainen yhteistyö ja skaalautuvuus
Yksi Outlinen erottavista ominaisuuksista on reaaliaikainen yhteiskäyttöinen asiakirjan muokkaus.
Useat käyttäjät voivat työstää samaa asiakirjaa samalla, kun muutokset synkronoidaan yhteistyöpalvelun kautta.
Vakiokäyttöönotoissa yhteistyöpalvelu toimii osana hakuprosessia.
Suuremmissa asennuksissa, joissa on useita sovellusinstansseja, Outline tukee Redis-pohjaista synkronointia REDIS_COLLABORATION_URL-määritysmuuttujan kautta.
Tämä mahdollistaa yhteistyötapahtumien koordinoinnin useiden prosessien välillä.
API-, verkko- ja työntekijäprosessit voidaan myös tarvittaessa skaalata toisistaan riippumatta.
Sopiva arkkitehtuuri riippuu samanaikaisista käyttäjistä, asiakirjan toiminnasta, liitetiedostojen määrästä ja infrastruktuurin resursseista.
Lisenssit ja versiot
Outline tarjoaa erilaisia lisensointivaihtoehtoja isännöidyille ja itse isännöidyille käyttöönotoille.
Nykyinen lähdekoodivarasto käyttää Business Source License 1.1 -lisenssiä.
Lisenssi sallii määritellyt käyttötarkoitukset, mukaan lukien organisaation sisäinen käyttö, mutta rajoittaa Outlinen tarjoamista kaupallisena asiakirjapalveluna kolmansille osapuolille ilman asianmukaista lisenssijärjestelyä.
Outline tarjoaa myös kaupallisia Business- ja Enterprise-versioita, joissa on lisätoimintoja, integraatioita ja tukea.
Ennen kuin käytät Outlinea kaupallisessa isännöintiympäristössä tai tarjoat sitä ulkoisille asiakkaille, tarkista voimassa olevat lisenssi- ja versiovaatimukset.
Johtopäätös
Outline on moderni yhteistyön tietokanta, joka on suunniteltu auttamaan tiimejä luomaan, järjestämään ja ylläpitämään dokumentaatiota keskitetyssä ympäristössä.
Jäsenneltyjen kokoelmien, sisäkkäisten asiakirjojen, reaaliaikaisen muokkauksen, kokotekstihaun, käyttöoikeuksien hallinnan, todennusintegraatioiden ja API-tuen ansiosta se tarjoaa kattavan alustan organisaation tiedon hallintaan.
Sen itseisännöidyn käyttöönottomallin avulla organisaatiot voivat käyttää omaa dokumentaatioinfrastruktuuriaan säilyttäen samalla sovellustietojen ja ladattujen tiedostojen hallinnan.
Outline on sopiva ratkaisu kehitystiimeille, IT-osastoille, yrityksille ja organisaatioille, jotka etsivät jäsenneltyä ja yhteistyökykyistä vaihtoehtoa perinteisille wiki-alustoille.

