Kirjaudu sisäänAloita ilmaiseksi
SovelluksetAlustaMarkkinapaikkaDokumentaatioHinnoitteluKirjaudu sisään
Dokumentaatio

Aloitusopas

obopia voi ajaa kolmella tavalla. Isännöity beta on nopein tapa kokeilla, Docker ja PostgreSQL sopivat oikeaan käyttöön, ja paikallinen versio on tarkoitettu kehitykseen.

Vaihtoehto 1: isännöity beta ​

Isännöity palvelu antaa jokaiselle yritykselle oman instanssin ja oman tietokannan. Se on ilmainen beta-vaiheen ajan.

  1. Rekisteröidy. Avaa rekisteröitymissovellus, kirjoita sähköpostiosoitteesi ja salasana ja valitse Create account.
  2. Luo instanssi. Anna sille nimi, jossa on 3–30 merkkiä. Osoite muodostetaan nimestä. Käyttöönotto kestää hetken, ja sivu näyttää etenemisen.
  3. Kirjaudu sisään. Siirry linkistä instanssiisi ja kirjaudu sisään samalla sähköpostiosoitteella ja salasanalla. Rekisteröitymistilistäsi tulee instanssin ensimmäinen ylläpitäjä.
  4. Asenna sovellus. Avaa Customize, sitten Marketplace, ja asenna sovellus, esimerkiksi Helpdesk tai Projects. Sovellusten asentaminen ja poistaminen vaatii ylläpitäjän ryhmän. Viisi sisäänrakennettua sovellusta (CRM, Sales, Invoicing, Products ja Contacts) on jo valmiina.
  5. Luo tietueita. Avaa sovellus, valitse New ja täytä lomake. Luettelot, taulut ja sivupaneeli muodostetaan sovelluksen kuvauksesta.
  6. Kutsu agentti. Agenttitunnisteille ei ole vielä omaa näkymää. Kirjaudu sisään REST-rajapinnan kautta ja luo agenttitunniste. Sen jälkeen voit yhdistää MCP:n kautta tai käyttää REST-rajapintaa.

Vaihtoehto 2: aja itse Dockerilla ja PostgreSQL:llä ​

Tarvitset Dockerin. Repositorion Compose-tiedosto käynnistää PostgreSQL:n ja obopin yhdessä, ja ne julkaistaan vain localhostissa:

bash
git clone https://github.com/SpaceCorps/obop.git
cd obop
docker compose up --build

Ensimmäinen koontiversio kääntää Rust-työtilan ja kestää hetken. Kun palvelu on käynnissä, avaa http://127.0.0.1:8080. Compose-tiedosto käynnistää obopin demotiedoilla (--demo) ja ilman käyttäjiä, joten luo ensimmäinen ylläpitäjä:

bash
docker compose exec obop obop admin create alice --all-groups

obop lukee salasanan vakiosyötteestä, joten sitä kysytään sinulta (vähintään 12 merkkiä). Kirjaudu sisään tunnuksella alice.

Jos haluat ajaa imagea oman PostgreSQL-tietokantasi kanssa, aseta OBOP_DATABASE_URL:

bash
docker build -t obop .
docker run -d --name obop -p 8080:8080 \
  -e OBOP_DATABASE_URL=postgres://user:password@host:5432/obop \
  obop

Image ajaa oletuksena yhtä instanssia. Sen komento on obop serve --addr 0.0.0.0:8080 --static /srv/backoffice. Ohjaustaso, varmuuskopiot ja puuttuvat ominaisuudet on kuvattu sivulla Oma ylläpito ja käyttö.

Vaihtoehto 3: paikallinen kehitys SQLitellä ​

Tarvitset Rust-työkalut tiedoston rust-toolchain.toml mukaisesti, pnpm:n ja Vite+:n (vp). SQLite on oletustallennus, joten tietokantapalvelinta ei tarvita.

bash
git clone https://github.com/SpaceCorps/obop.git
cd obop
cargo build
vp install
(cd web/apps/backoffice && vp build)
echo "a password of 12+ characters" | cargo run -- admin create alice --all-groups
cargo run -- serve --static web/apps/backoffice/dist

Avaa http://127.0.0.1:8080 ja kirjaudu sisään tunnuksella alice. Tiedot tallentuvat nykyisen hakemiston tiedostoon obop.db; toisen tiedoston voi ottaa käyttöön valitsimella --db sqlite:///path/to/file.db. Uusi, tyhjä SQLite-tietokanta täytetään automaattisesti keksityillä demotiedoilla (--demo pakottaa täytön).

--dev-auth korvaa oikean kirjautumisen kiinteillä tunnisteilla dev-admin, dev-sales ja dev-agent. Se kieltäytyy sitoutumasta muuhun kuin localhostiin.

Mitä seuraavaksi ​