Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gcotelli committed Nov 3, 2023
1 parent 6ce6868 commit cc75e2c
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 7 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,14 @@ within the image.

[![Baseline Groups](https://github.com/ba-st/Launchpad/actions/workflows/loading-groups.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/loading-groups.yml)
[![GS64 Components](https://github.com/ba-st/Launchpad/actions/workflows/loading-gs64-components.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/loading-gs64-components.yml)
[![Pharo Docker Build](https://github.com/ba-st/Launchpad/actions/workflows/docker-build.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/docker-build.yml)
[![GS64 Docker Build](https://github.com/ba-st/Launchpad/actions/workflows/docker-build-gs64.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/docker-build-gs64.yml)
[![Markdown Lint](https://github.com/ba-st/Launchpad/actions/workflows/markdown-lint.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/markdown-lint.yml)
[![Shellcheck](https://github.com/ba-st/Stargate/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/shellcheck.yml)

[![Pharo Docker Build](https://github.com/ba-st/Launchpad/actions/workflows/docker-build.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/docker-build.yml)
[![GS64 Docker Build](https://github.com/ba-st/Launchpad/actions/workflows/docker-build-gs64.yml/badge.svg)](https://github.com/ba-st/Launchpad/actions/workflows/docker-build-gs64.yml)

[![GitHub release](https://img.shields.io/github/release/ba-st/Launchpad.svg)](https://github.com/ba-st/Launchpad/releases/latest)

[![Pharo 8.0](https://img.shields.io/badge/Pharo-8.0-informational)](https://pharo.org)
[![Pharo 9.0](https://img.shields.io/badge/Pharo-9.0-informational)](https://pharo.org)
[![Pharo 10](https://img.shields.io/badge/Pharo-10-informational)](https://pharo.org)
[![Pharo 11](https://img.shields.io/badge/Pharo-11-informational)](https://pharo.org)

Expand Down
12 changes: 12 additions & 0 deletions docs/reference/CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ vast/bin/esnx \
launchpad <arguments>
```

For [GemStone/S 64](https://gemtalksystems.com/products/gs64/versions37x/) the command must be passed after the topaz arguments:

```bash
topaz -l -- launchpad <arguments>
```

and starting the command line handler by evaluating:

```smalltalk
LaunchpadCommandLineHandler activateWith: (CommandLineArguments new copyAfter: '--')
```

For the sake of simplicity, from now on we will omit in the examples the VM and
image parameters:

Expand Down
28 changes: 25 additions & 3 deletions docs/reference/Docker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Docker support

## Docker support for Pharo

Launchpad provides a Docker image that can be used as base for containerized
applications. It's built on top of [pharo:v11.0.0](https://github.com/ba-st/docker-pharo-runtime),
adding some useful scripts for Launchpad-based applications:
Expand All @@ -11,7 +13,7 @@ adding some useful scripts for Launchpad-based applications:
a `SIGTERM` handler for gracefully stopping the application.
- `launchpad-healthcheck` is run as the default docker `HEALTHCHECK`

## How to use as base docker image
### How to use as base pharo docker image

In your Dockerfile put something like:

Expand All @@ -20,7 +22,7 @@ FROM ghcr.io/ba-st/pharo-loader:v11.0.0 AS loader
# Load your own application
RUN pharo metacello install github://owner/repo:branch BaselineOfProject
FROM ghcr.io/ba-st/launchpad:v4
FROM ghcr.io/ba-st/launchpad:v5
COPY --from=loader /opt/pharo/Pharo.image ./
COPY --from=loader /opt/pharo/Pharo*.sources ./
Expand All @@ -29,8 +31,28 @@ COPY --from=loader /opt/pharo/Pharo*.sources ./
CMD [ "launchpad-start", "app-name" , "--parameter=value" ]
```

## Environment variables
### Environment variables

- `LAUNCHPAD__COMMAND_SERVER_PORT` defines in which port is listening the TCP
command server. Defaults to 22222.
- `LAUNCHPAD__LOG_FORMAT` can be set to `json` to enable structured logging

## Docker support for GemStone/S 64

Launchpad provides a Docker image that can be used as base for containerized
gems. It's built on top of [gs64-gem:v3.7.0](https://github.com/ba-st/Docker-GemStone-64),
adding some useful scripts for Launchpad-based applications:

- `launchpad` starts the CLI

### How to use as base gem docker image

In your Dockerfile put something like:

```docker
FROM ghcr.io/ba-st/launchpad-gs64:v5
# Your own directives
CMD [ "launchpad", "start", "app-name" , "--parameter=value" ]
```
9 changes: 9 additions & 0 deletions docs/reference/Tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,12 @@ When using Launchpad in Pharo the following dumpers are available:
opened in a Pharo image and debugged live using the familiar tooling.
- `NullStackTraceDumper` emits a warning and doesn't produce any stack trace. Its
usage is discouraged in production environments.

## Stack tracing for GemStone/S 64

When using Launchpad in GemStone/S the following dumpers are available:

- `StackTraceTextDumper` produces a textual stack trace written to the
configured stream.
- `NullStackTraceDumper` emits a warning and doesn't produce any stack trace. Its
usage is discouraged in production environments.

0 comments on commit cc75e2c

Please sign in to comment.