hub-description-template.md 5.78 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
- [Supported Tags](#org84c1ce9)
  - [Simple Tags](#orgbe67b7a)
  - [Shared Tags](#orgf93f946)
- [Quick Reference](#org8ba9656)
- [What is CCL?](#org4c4f99a)
- [How to use this image](#orgc28e470)
  - [Create a `Dockerfile` in your CCL project](#org1cd01d7)
  - [Run a single Common Lisp script](#org408fbfb)
  - [Developing using SLIME](#org89042b6)
- [Image variants](#orga8c2629)
  - [`%%IMAGE%%:<version>`](#orga222644)
  - [`%%IMAGE%%:<version>-slim`](#org936d2d3)
  - [`%%IMAGE%%:<version>-windowsservercore`](#orgd3e09ae)
- [License](#org1fcd298)
Eric Timmons's avatar
Eric Timmons committed
15
16
17



18
<a id="org84c1ce9"></a>
Eric Timmons's avatar
Eric Timmons committed
19
20
21
22

# Supported Tags


23
<a id="orgbe67b7a"></a>
Eric Timmons's avatar
Eric Timmons committed
24
25
26
27
28
29

## Simple Tags

INSERT-SIMPLE-TAGS


30
<a id="orgf93f946"></a>
Eric Timmons's avatar
Eric Timmons committed
31
32
33
34
35
36

## Shared Tags

INSERT-SHARED-TAGS


37
<a id="org8ba9656"></a>
Eric Timmons's avatar
Eric Timmons committed
38
39
40
41
42
43

# Quick Reference

-   **CCL Home Page:** [https://ccl.clozure.com/](https://ccl.clozure.com/)
-   **Where to file Docker image related issues:** <https://gitlab.common-lisp.net/cl-docker-images/ccl>
-   **Where to file issues for CCL itself:** [https://github.com/Clozure/ccl/issues](https://github.com/Clozure/ccl/issues)
44
-   **Maintained by:** [CL Docker Images Project](https://common-lisp.net/project/cl-docker-images)
Eric Timmons's avatar
Eric Timmons committed
45
46
47
-   **Supported architectures:** `linux/amd64`, `linux/arm/v7`, `windows/amd64`


48
<a id="org4c4f99a"></a>
Eric Timmons's avatar
Eric Timmons committed
49
50
51
52
53
54
55
56

# What is CCL?

From [CCL's Home Page](https://ccl.clozure.com):

> Clozure CL (often called CCL for short) is a free Common Lisp implementation with a long history. Some distinguishing features of the implementation include fast compilation speed, native threads, a precise, generational, compacting garbage collector, and a convenient foreign-function interface.


57
<a id="orgc28e470"></a>
Eric Timmons's avatar
Eric Timmons committed
58
59
60
61

# How to use this image


62
<a id="org1cd01d7"></a>
Eric Timmons's avatar
Eric Timmons committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

## Create a `Dockerfile` in your CCL project

```dockerfile
FROM %%IMAGE%%:latest
COPY . /usr/src/app
WORKDIR /usr/src/app
CMD [ "ccl", "--load", "./your-daemon-or-script.lisp" ]
```

You can then build and run the Docker image:

```console
$ docker build -t my-ccl-app
$ docker run -it --rm --name my-running-app my-ccl-app
```


81
<a id="org408fbfb"></a>
Eric Timmons's avatar
Eric Timmons committed
82
83
84
85
86
87
88
89
90
91

## 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 CCL Docker image directly:

```console
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app %%IMAGE%%:latest ccl --load ./your-daemon-or-script.lisp
```


92
<a id="org89042b6"></a>
Eric Timmons's avatar
Eric Timmons committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

## 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 ccl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app %%IMAGE%%:latest ccl --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
```


109
<a id="orga8c2629"></a>
Eric Timmons's avatar
Eric Timmons committed
110
111
112
113
114
115

# Image variants

This image comes in several variants, each designed for a specific use case.


116
<a id="orga222644"></a>
Eric Timmons's avatar
Eric Timmons committed
117
118
119
120
121
122
123
124
125

## `%%IMAGE%%:<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.

These images are built off the buildpack-deps image. It, by design, has a large number of extremely common Debian packages.

126
These images contain the Quicklisp installer, located at `/usr/local/share/common-lisp/source/quicklisp/quicklisp.lisp`.
Eric Timmons's avatar
Eric Timmons committed
127

128

129
<a id="org936d2d3"></a>
Eric Timmons's avatar
Eric Timmons committed
130
131
132
133
134
135

## `%%IMAGE%%:<version>-slim`

This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run CCL. 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.


136
<a id="orgd3e09ae"></a>
Eric Timmons's avatar
Eric Timmons committed
137
138
139
140
141
142
143
144
145
146
147

## `%%IMAGE%%:<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)


148
<a id="org1fcd298"></a>
Eric Timmons's avatar
Eric Timmons committed
149
150
151
152
153
154
155
156
157
158

# License

CCL is licensed under the [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0).

The Dockerfiles used to build the images are licensed under BSD-2-Clause.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.