Commandoregel 26.03

Openen in ChatGPT

De opdrachtregel bbjship beheert BBjShip op de BBj-machine. De opdracht staat in <BBj home>/plugins/webforj-bbjship en heet bbjship.cmd op Windows. Elke opdracht wordt uitgevoerd binnen BBjServices. Daarom moet BBjServices voor elke opdracht actief zijn.

bbjship <group> <command> [options]

Opdrachten

Opdracht	Beschrijving
remote enable [--port PORT] [--ssl-port PORT] [--allow-unencrypted]	Schakelt het implementatie-eindpunt in of werkt het bij en geeft de adressen weer.
remote disable	Verwijdert het implementatie-eindpunt. Geïmplementeerde apps blijven actief.
remote status	Geeft de eindpuntadressen weer, of ontwikkeluitvoeringen zijn ingeschakeld en of niet-versleutelde aanvragen vanaf een andere machine zijn toegestaan.
apps deploy ARCHIVE	Implementeert een implementatiearchief.
apps list [--long]	Geeft de apps weer die BBjShip heeft geïmplementeerd.
apps undeploy NAME, apps undeploy --all	Verwijdert één of alle apps die BBjShip heeft geïmplementeerd.
development enable, development disable	Schakelt ontwikkeluitvoeringen op deze machine in of uit.
reset [--yes] [--properties FILE]	Verwijdert alle apps en alles wat BBjShip heeft ingesteld.

Gedeelde opties

Instelling	Standaard	Beschrijving
--username USER	Niet ingesteld	Gebruikersnaam van de BBj-beheerder.
--password PASSWORD	Niet ingesteld	Wachtwoord van de BBj-beheerder.
--password-stdin	Uit	Leest het wachtwoord uit de eerste regel van standaardinvoer. Niet beschikbaar op Windows.
--help, -h		Geeft het gebruik van de opdrachtregel of een afzonderlijke opdracht weer.
--version, -V		Geeft de BBjShip-versie weer.

Een wachtwoord dat met --password wordt opgegeven, is tijdens het uitvoeren van de opdracht zichtbaar voor andere gebruikers van de machine in de proceslijst. Op macOS en Linux kan een script het wachtwoord in plaats daarvan via standaardinvoer doorgeven:

printf '%s\n' "$PASSWORD" | bbjship remote enable --username admin --password-stdin

Op elk systeem houden de variabelen het wachtwoord buiten de opdrachtregel:

WEBFORJ_BBJ_USERNAME=admin WEBFORJ_BBJ_PASSWORD="$PASSWORD" bbjship remote enable

Op Windows is standaardinvoer niet beschikbaar. Daarom eindigt --password-stdin met afsluitcode 2. Geef het wachtwoord op als waarde of via de variabelen:

bbjship.cmd remote enable --username admin --password <value>

Als je zowel --password als --password-stdin opgeeft, een gebruikersnaam zonder wachtwoord of een wachtwoord zonder gebruikersnaam, eindigt de opdracht met afsluitcode 2 en een bericht dat aangeeft wat je moet opgeven.

Zonder aanmeldgegevens gebruikt de opdracht het fabrieksaccount admin met het wachtwoord admin123 en geeft een waarschuwing weer.

Omgevingsvariabelen

Variabele	Standaard	Beschrijving
WEBFORJ_BBJ_USERNAME	Niet ingesteld	Gebruikersnaam als --username ontbreekt.
WEBFORJ_BBJ_PASSWORD	Niet ingesteld	Wachtwoord als noch --password, noch --password-stdin is opgegeven.
NO_COLOR	Niet ingesteld	Schakelt gekleurde uitvoer uit.

Extern

De opdrachten remote beheren het implementatie-eindpunt.

remote enable

bbjship remote enable [--port PORT] [--ssl-port PORT] [--allow-unencrypted]

Schakelt het implementatie-eindpunt in of werkt het bij en geeft de adressen weer.

Instelling	Standaard	Beschrijving
--port PORT	8888	HTTP-poort van de BBjServices-webserver voor het eindpunt.
--ssl-port PORT	Geen	SSL-poort van de BBjServices-webserver voor het eindpunt. Zonder deze optie heeft het eindpunt geen HTTPS-adres.
--allow-unencrypted	Uit	Accepteert de beheerdersaanmeldgegevens via HTTP vanaf een andere machine. Zonder deze optie moet een aanvraag vanaf een andere machine de SSL-poort gebruiken en antwoordt het eindpunt daarop met HTTP 403. Aanvragen vanaf de BBj-machine zelf gebruiken in beide gevallen HTTP.

De poorten moeten poorten zijn waarop de BBjServices-webserver al luistert. Anders eindigt remote enable met afsluitcode 1, wordt aangegeven welke poort niet reageert en blijft het vorige eindpunt behouden.

Elke uitvoering van remote enable slaat de poorten en de instelling --allow-unencrypted opnieuw op. Een uitvoering zonder de optie schakelt de instelling uit en geeft Refused unencrypted requests from another machine weer. Een uitvoering met de optie geeft Allowed unencrypted requests from another machine weer. De build die via HTTP implementeert vanaf een andere machine, stelt ook allowUnencrypted in.

remote disable

bbjship remote disable

Verwijdert het implementatie-eindpunt. Geïmplementeerde apps blijven actief.

Builds kunnen niet implementeren

remote disable verwijdert het implementatie-eindpunt. Builds en CI-taken die ernaar implementeren, mislukken totdat je remote enable opnieuw uitvoert. Noteer de poorten en het eindpuntadres voordat je het uitschakelt. Geïmplementeerde apps blijven actief.

remote status

bbjship remote status

Geeft de eindpuntadressen weer, of ontwikkeluitvoeringen zijn ingeschakeld en of niet-versleutelde aanvragen vanaf een andere machine zijn toegestaan.

$ bbjship remote status
Enabled http://localhost:8888/webforj-bbjship
Enabled https://localhost:8443/webforj-bbjship
Development runs  disabled
Unencrypted requests  refused

Apps

De opdrachten apps geven alleen apps weer en verwijderen alleen apps die BBjShip heeft geïmplementeerd. Apps die zijn geregistreerd in Enterprise Manager worden niet beïnvloed.

apps deploy

bbjship apps deploy ARCHIVE

Implementeert een implementatiearchief. apps deploy installeert een archief dat is gemaakt door bbj-package, zonder het implementatie-eindpunt. De bestandsnaam zonder .zip is de publicatienaam. BBjServices leest het archief, dus de besturingssysteemgebruiker van BBjServices moet leestoegang hebben.

$ bbjship apps deploy inventory.zip
Deployed inventory /webapp/inventory

Vervangt de app

Als je een archief implementeert met de naam van een app die al is geïmplementeerd, wordt die app vervangen. De vorige implementatiemap wordt verwijderd en de actieve sessies van de app worden beëindigd. Bewaar het vorige archief voor het geval je wilt terugkeren naar de vorige versie.

apps list

bbjship apps list [--long]

Geeft de apps weer die BBjShip heeft geïmplementeerd.

Instelling	Standaard	Beschrijving
--long, -l	Uit	Voegt de implementatiemap en de klassenmappen van elke app toe.

$ bbjship apps list
NAME       URL
inventory  /webapp/inventory

apps undeploy

bbjship apps undeploy NAME
bbjship apps undeploy --all

Verwijdert één of alle apps die BBjShip heeft geïmplementeerd.

Instelling	Standaard	Beschrijving
--all	Uit	Maakt de implementatie ongedaan van alle apps die BBjShip heeft geïmplementeerd.

Kan niet ongedaan worden gemaakt

apps undeploy verwijdert de app uit Enterprise Manager, beëindigt de actieve sessies en verwijdert de implementatiemap. apps undeploy --all doet dit voor alle apps die BBjShip heeft geïmplementeerd. Dit kan niet ongedaan worden gemaakt. Bewaar het implementatiearchief van elke app, bijvoorbeeld target/bbj/<publish name>.zip, zodat je de app opnieuw kunt implementeren.

Development

Ontwikkeluitvoeringen zijn uitgeschakeld bij een nieuwe installatie. De eerste webforj:watch op dezelfde machine schakelt ze in. bbjship development disable schakelt ze uit totdat de volgende webforj:watch op deze machine ze weer inschakelt. Een ontwikkeluitvoering vanaf een andere machine wordt geweigerd, omdat de installatie die als eerste wordt uitgevoerd alleen op de BBj-machine werkt.

development enable

bbjship development enable

Schakelt ontwikkeluitvoeringen in op deze machine.

development disable

bbjship development disable

Schakelt ontwikkeluitvoeringen uit op deze machine.

Reset

bbjship reset [--yes] [--properties FILE]

reset maakt de implementatie ongedaan van alle apps die BBjShip heeft geïmplementeerd, verwijdert het implementatie-eindpunt, de ontwikkelschakelaar en de instelling --allow-unencrypted, herstelt het BBjServices-eigenschappenbestand dat door een ontwikkeluitvoering is gewijzigd en verwijdert de bestanden die BBjShip heeft geschreven. De opdracht stopt BBjServices nooit. Nadat het eigenschappenbestand is hersteld, moet je BBjServices opnieuw starten om de wijzigingen toe te passen. De plug-inmap blijft behouden.

Instelling	Standaard	Beschrijving
--yes	Uit	Slaat de bevestiging over.
--properties FILE	<BBj home>/cfg/BBj.properties	Het BBjServices-eigenschappenbestand dat reset herstelt.

De opdracht geeft weer wat deze gaat doen en vraagt om bevestiging, tenzij --yes is opgegeven. Op Windows eindigt reset zonder --yes met afsluitcode 2 voordat de opdracht zich aanmeldt.

Maak eerst een back-up

reset kan niet ongedaan worden gemaakt. De opdracht verwijdert de map van elke app die BBjShip heeft geïmplementeerd en beëindigt de actieve sessies. Bewaar voordat je de opdracht uitvoert het implementatiearchief van elke app, bijvoorbeeld het bestand target/bbj/<publish name>.zip van de build, en maak een back-up van <BBj home>/cfg/BBj.properties. Als er een kopie van het bestand is bewaard in de runtime-map van BBjShip, zet reset die kopie terug over cfg/BBj.properties. Eventuele wijzigingen die je na de eerste ontwikkeluitvoering in het bestand hebt aangebracht, gaan daardoor verloren. Start BBjServices daarna opnieuw om de herstelde Java-instellingen toe te passen.

Afsluitcodes

Code	Betekenis
0	De opdracht is geslaagd.
1	De opdracht is mislukt en heeft de oorzaak weergegeven, of reset is geannuleerd.
2	De argumenten zijn ongeldig of de opdracht heeft standaardinvoer nodig op Windows. Het bericht geeft aan wat je moet opgeven.

Probleemoplossing bevat de berichten en wat je bij elk bericht kunt doen.