Konto i namespace'y

Do tworzenia i publikowania modułów potrzebujesz tylko konta Orbito — tego samego, którym logujesz się do panelu na my.orbi.do. Repozytorium modułów (modules.orbito.pl) nie ma własnych haseł ani rejestracji.

Moduły nie należą do osoby, tylko do namespace'u — wspólnej przestrzeni zespołu. Kod modułu to namespace/slug, np. acme/hello.

Konto Orbito

Nie masz konta? Załóż je na my.orbi.do. Do testów modułów potrzebna jest też firma w Orbito, w której masz konto. Tym samym e-mailem i hasłem logujesz się:

do panelu developera repozytorium: modules.orbito.pl, przycisk „Zaloguj się” (link „Załóż konto w Orbito” prowadzi do rejestracji w panelu Orbito),
do CLI omm: jedno omm login loguje jednocześnie do Orbito Core i do repozytorium.

omm login            # e-mail i hasło konta Orbito
omm whoami           # konto w repozytorium i Twoje namespace'y z rolą
omm whoami --core    # konto w Orbito Core i firma robocza

Szczegóły logowania z CLI: omm — Logowanie.

Namespace

Namespace to właściciel modułów. Należy do niego jeden właściciel (owner) i dowolnie wielu członków (member):

Rola	Może
`member`	wszystko przy modułach namespace'u: zakładać karty, edytować je, publikować wersje, ustawiać sekrety i link do repozytorium kodu, nadawać firmom dostęp; odpowiadać na recenzje i je ukrywać, akceptować pytania pod modułami (Recenzje i pytania)
`owner`	to samo co `member`, a do tego dodaje i usuwa członków oraz zaproszenia i edytuje profil publiczny namespace'u

Zasady:

nazwa: małe litery, cyfry i -, od 3 do 30 znaków (^[a-z0-9-]{3,30}$), unikalna w całym repozytorium,
nazwy nie da się później zmienić — jest częścią kodu każdego modułu,
namespace'u nie da się usunąć ani przekazać innej osobie; właściciela nie można usunąć.

Tworzenie

omm namespace create acme          # zakłada namespace, Ty jesteś właścicielem
omm namespace list                 # Twoje namespace'y z rolą (owner / member)

W panelu developera: menu „Namespace'y” → „Nowy namespace”.

Członkowie i zaproszenia

Członka dodaje właściciel, podając e-mail konta Orbito tej osoby:

omm namespace invite acme anna@acme.pl     # dodaje członka albo zapisuje zaproszenie
omm namespace members acme                 # właściciel, członkowie i oczekujące zaproszenia
omm namespace remove acme anna@acme.pl     # usuwa członka albo anuluje zaproszenie

Jeśli osoba logowała się już do repozytorium (panel developera albo omm login), od razu zostaje członkiem.
Jeśli nie — powstaje zaproszenie. Zamienia się w członkostwo przy jej pierwszym logowaniu do repozytorium tym e-mailem.
Repozytorium nie wysyła maili. Daj znać zapraszanej osobie sam.

To samo zrobisz w panelu developera na stronie namespace'u (karty „Członkowie” i „Zaproszenia”).

Kod modułu

Kartę modułu zakładasz w wybranym namespace — repozytorium nadaje kod <namespace>/<slug nazwy>:

omm init "Hello"                       # jedyny namespace: wybierany automatycznie
omm init "Hello" --namespace acme      # kilka namespace'ów: wskaż jeden

W panelu developera namespace wybierasz w formularzu „Utwórz nowy moduł”. Kod trafia do pola name w module.json i nie zmienia się. Publikować wersje tego modułu może każdy członek namespace'u.

Moduły robocze i dostęp firm

Moduł, który nie ma jeszcze opublikowanej wersji, oraz każda wersja robocza (draft) są widoczne tylko dla:

członków namespace'u modułu — w każdej firmie, do której należą,
firm z dostępem do modułu (grant).

Dostęp firmy powstaje na dwa sposoby:

Automatycznie — gdy członek namespace'u instaluje lub aktualizuje moduł roboczy w firmie (omm install, omm update albo marketplace w panelu). Od tej chwili firma ma moduł na stałe: działa po restarcie kontenera i widzą go pozostali użytkownicy firmy.
Ręcznie — członek namespace'u nadaje dostęp innej firmie w panelu developera: szczegóły modułu → karta „Dostęp firm” → „Nadaj dostęp”, z identyfikatorem firmy. Tam też dostęp odbierzesz.

Identyfikator firmy (24 znaki, np. 67da8b39e220f2cc898c9367) znajdziesz w panelu Orbito: Ustawienia → Firma, sekcja „Identyfikator firmy” (zakładki „Firma” nie widzą użytkownicy z rolą user). Każdy członek firmy sprawdzi go też w CLI:

omm company list     # Twoje firmy z identyfikatorami

Wersje opublikowane (omm publish --release) widzą wszystkie firmy — dostęp nie jest wtedy potrzebny.

Nie ma już dev-tokenu

Dawny dev-token firmy (omm company dev-token, pole w ustawieniach firmy) został usunięty. Zastąpiły go członkostwo w namespace i dostęp firm opisany wyżej.

Profil publiczny

Namespace i użytkownik mają publiczne strony w sklepie modules.orbito.pl, widoczne bez logowania:

/@<namespace> (np. /@acme) — profil namespace'u, jego opublikowane moduły, liczba modułów i instalacji oraz właściciel,
/users/<id> — profil użytkownika i jego namespace'y. Link do własnego profilu jest w menu konta w sklepie („Mój profil”).

Wszystkie pola profilu są opcjonalne:

Profil	Pole	Limit
namespace	nazwa wyświetlana	60 znaków
namespace	opis	markdown, 4000 znaków
namespace	strona WWW	adres `http://` albo `https://`, 200 znaków
namespace	lokalizacja	80 znaków
użytkownik	bio	markdown, 2000 znaków
użytkownik	strona WWW	adres `http://` albo `https://`, 200 znaków
oba	awatar	PNG, JPG albo WebP, do 512 KB

Profile edytujesz w panelu developera na modules.orbito.pl:

profil namespace'u — na stronie namespace'u; zmienia go tylko właściciel,
własny profil — w ustawieniach konta (menu konta → „Ustawienia konta”).

Nazwa użytkownika przy recenzjach, pytaniach i postach to nazwa konta Orbito. E-mail nigdy nie jest publiczny. Zmiana profilu pojawia się na stronach publicznych najpóźniej po minucie.

Role

Poza rolami w namespace'ach (owner, member) konto w repozytorium może mieć rolę moderator. Moderator pilnuje treści społeczności we wszystkich modułach: odpowiada na recenzje i je ukrywa, akceptuje, odrzuca i usuwa pytania, a na forum usuwa wątki i posty, przypina, blokuje i przenosi wątki oraz zarządza kategoriami. Szczegóły: Recenzje i pytania.

Rolę nadaje administrator Orbito skryptem w repozytorium repo-backend (konto musi choć raz zalogować się do modules.orbito.pl):

node scripts/set-user-role.js anna@acme.pl moderator            # nadanie
node scripts/set-user-role.js anna@acme.pl moderator --remove   # odebranie

Tokeny publikacji

omm i CI uwierzytelniają się w repozytorium tokenem publikacji (omm_…). Token działa w imieniu Twojego konta we wszystkich Twoich namespace'ach.

omm login tworzy go sam (nazwa omm-<nazwa komputera>) i zapisuje w ~/.config/omm/config.json; omm logout go unieważnia.
Token dla CI wygenerujesz w panelu developera: menu konta → „Ustawienia konta” → karta „Tokeny publikacji” → „Nowy token”. Pełna wartość pokazuje się tylko raz — skopiuj ją od razu. Tam też usuniesz token.

export OMM_TOKEN=omm_...
omm publish --release

Więcej: omm — Publikacja z CI.

Migracja z dawnych kont developera

Repozytorium miało wcześniej własne konta (login i hasło). Te konta już nie działają:

Zaloguj się kontem Orbito z tym samym e-mailem co dawne konto developera. Jeśli go nie masz, załóż je na my.orbi.do.
Moduły dawnego konta trafiają do namespace'u o nazwie dawnego loginu, a Ty zostajesz jego właścicielem — kody modułów się nie zmieniają. Przeniesienie wykonuje operator platformy.
Moduły Orbito (core/orders, core/allegro …) są w namespace core.
Po aktualizacji do omm 2.0.0 zaloguj się ponownie: omm login. Komenda omm login --core działa jak zwykłe omm login (flaga wybiera tylko adres rdzenia).