Commit 01a3f7bf authored by Eric Timmons's avatar Eric Timmons

Update hub description to add variants and usage info

parent 081740ce
Pipeline #2108 canceled with stages
in 30 minutes and 55 seconds
- [Supported Tags](#org6727bb9)
- [Simple Tags](#orgcd349a8)
- [Shared Tags](#org6b0d84e)
- [Quick Reference](#orgf31b96e)
- [What is ABCL?](#orgd250a98)
- [What's in the image?](#org5fd92f5)
- [License](#org71f6146)
- [Supported Tags](#orgb6038d1)
- [Simple Tags](#org3ed66e5)
- [Shared Tags](#orga5a4c7e)
- [Quick Reference](#org33050be)
- [What is ABCL?](#org2c21a0c)
- [How to use this iamge](#org0c93268)
- [Create a `Dockerfile` in your ABCL project](#org5e2c353)
- [Run a single Common Lisp script](#orge3a1ae4)
- [Developing using SLIME](#org57abc30)
- [Image variants](#org6244e31)
- [`clfoundation/abcl:<version>`](#org87740a4)
- [`clfoundation/abcl:<version>-slim`](#org5224a51)
- [`clfoundation/abcl:<version>-windowsservercore`](#org80ff69f)
- [License](#orga22aee5)
<a id="org6727bb9"></a>
<a id="orgb6038d1"></a>
# Supported Tags
<a id="orgcd349a8"></a>
<a id="org3ed66e5"></a>
## Simple Tags
INSERT-SIMPLE-TAGS
<a id="org6b0d84e"></a>
<a id="orga5a4c7e"></a>
## Shared Tags
INSERT-SHARED-TAGS
<a id="orgf31b96e"></a>
<a id="org33050be"></a>
# Quick Reference
......@@ -38,7 +45,7 @@ INSERT-SHARED-TAGS
- **Supported platforms:** `linux/amd64`, `linux/arm64/v8`, `windows/amd64`
<a id="orgd250a98"></a>
<a id="org2c21a0c"></a>
# What is ABCL?
......@@ -47,14 +54,96 @@ From [ABCL's Home Page](https://abcl.org)
> Armed Bear Common Lisp (ABCL) is a full implementation of the Common Lisp language featuring both an interpreter and a compiler, running in the JVM. Originally started to be a scripting language for the J editor, it now supports JSR-223 (Java scripting API): it can be a scripting engine in any Java application. Additionally, it can be used to implement (parts of) the application using Java to Lisp integration APIs.
<a id="org5fd92f5"></a>
<a id="org0c93268"></a>
# What's in the image?
# How to use this iamge
This image contains ABCL binaries released by the upstream devs.
<a id="org5e2c353"></a>
<a id="org71f6146"></a>
## Create a `Dockerfile` in your ABCL project
```dockerfile
FROM %%IMAGE%%:latest
COPY . /usr/src/app
WORKDIR /usr/src/app
CMD [ "abcl", "--load", "./your-daemon-or-script.lisp" ]
```
You can then build and run the Docker image:
```console
$ docker build -t my-abcl-app
$ docker run -it --rm --name my-running-app my-abcl-app
```
<a id="orge3a1ae4"></a>
## Run a single Common Lisp script
For many simple, single file projects, you may find it inconvenient to write a complete \`Dockerfile\`. In such cases, you can run a Lisp script by using the ABCL Docker image directly:
```console
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load ./your-daemon-or-script.lisp
```
<a id="org57abc30"></a>
## Developing using SLIME
[SLIME](https://common-lisp.net/project/slime/) provides a convenient and fun environment for hacking on Common Lisp. To develop using SLIME, first start the Swank server in a container:
```console
$ docker run -it --rm --name abcl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load /usr/src/slime/swank-loader.lisp --eval '(swank-loader:init)' --eval '(swank:create-server :dont-close t :interface "0.0.0.0")'
```
Then, in an Emacs instance with slime loaded, type:
```emacs
M-x slime-connect RET RET RET
```
<a id="org6244e31"></a>
# Image variants
This image comes in several variant, each designed for a specific use case.
<a id="org87740a4"></a>
## `clfoundation/abcl:<version>`
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
Some of these tags may have names like buster or stretch in them. These are the suite code names for releases of Debian and indicate which release the image is based on. If your image needs to install any additional packages beyond what comes with the image, you'll likely want to specify one of these explicitly to minimize breakage when there are new releases of Debian.
This tag attempts to replicate the base environment provided by buildpack-deps. It, by design, has a large number of extremely common Debian packages.
<a id="org5224a51"></a>
## `clfoundation/abcl:<version>-slim`
This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run ABCL. Unless you are working in an environment where only this image will be deployed and you have space constraints, we highly recommend using the default image of this repository.
<a id="org80ff69f"></a>
## `clfoundation/abcl:<version>-windowsservercore`
This image is based on [Windows Server Core (`microsoft/windowsservercore`)](https://hub.docker.com/_/microsoft-windows-servercore). As such, it only works in places which that image does, such as Windows 10 Professional/Enterprise (Anniversary Edition) or Windows Server 2016.
For information about how to get Docker running on Windows, please see the relevant "Quick Start" guide provided by Microsoft:
- [Windows Server Quick Start](https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_server)
- [Windows 10 Quick Start](https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_10)
<a id="orga22aee5"></a>
# License
......
......@@ -32,9 +32,90 @@
application using Java to Lisp integration APIs.
#+end_quote
* What's in the image?
* How to use this iamge
This image contains ABCL binaries released by the upstream devs.
** Create a =Dockerfile= in your ABCL project
#+begin_src dockerfile
FROM %%IMAGE%%:latest
COPY . /usr/src/app
WORKDIR /usr/src/app
CMD [ "abcl", "--load", "./your-daemon-or-script.lisp" ]
#+end_src
You can then build and run the Docker image:
#+begin_src console
$ docker build -t my-abcl-app
$ docker run -it --rm --name my-running-app my-abcl-app
#+end_src
** Run a single Common Lisp script
For many simple, single file projects, you may find it inconvenient to write
a complete `Dockerfile`. In such cases, you can run a Lisp script by using
the ABCL Docker image directly:
#+begin_src console
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load ./your-daemon-or-script.lisp
#+end_src
** Developing using SLIME
[[https://common-lisp.net/project/slime/][SLIME]] provides a convenient and fun environment for hacking on Common
Lisp. To develop using SLIME, first start the Swank server in a container:
#+begin_src console
$ docker run -it --rm --name abcl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load /usr/src/slime/swank-loader.lisp --eval '(swank-loader:init)' --eval '(swank:create-server :dont-close t :interface "0.0.0.0")'
#+end_src
Then, in an Emacs instance with slime loaded, type:
#+begin_src emacs
M-x slime-connect RET RET RET
#+end_src
* Image variants
This image comes in several variant, each designed for a specific use case.
** =clfoundation/abcl:<version>=
This is the defacto image. If you are unsure about what your needs are, you
probably want to use this one. It is designed to be used both as a throw
away container (mount your source code and start the container to start your
app), as well as the base to build other images off of.
Some of these tags may have names like buster or stretch in them. These are
the suite code names for releases of Debian and indicate which release the
image is based on. If your image needs to install any additional packages
beyond what comes with the image, you'll likely want to specify one of these
explicitly to minimize breakage when there are new releases of Debian.
This tag attempts to replicate the base environment provided by
buildpack-deps. It, by design, has a large number of extremely common Debian
packages.
** =clfoundation/abcl:<version>-slim=
This image does not contain the common packages contained in the default tag
and only contains the minimal packages needed to run ABCL. Unless you are
working in an environment where only this image will be deployed and you
have space constraints, we highly recommend using the default image of this
repository.
** =clfoundation/abcl:<version>-windowsservercore=
This image is based on [[https://hub.docker.com/_/microsoft-windows-servercore][Windows Server Core
(=microsoft/windowsservercore=)]]. As such, it only works in places which that
image does, such as Windows 10 Professional/Enterprise (Anniversary Edition)
or Windows Server 2016.
For information about how to get Docker running on Windows, please see the
relevant "Quick Start" guide provided by Microsoft:
+ [[https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_server][Windows Server Quick Start]]
+ [[https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_10][Windows 10 Quick Start]]
* License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment