all: support containerization

Author: changkun

Makefile

@@ -1,12 +1,20 @@
-BUILD=ssaplayground.out
-all:
+NAME=ssaplayground
+BUILD=$(NAME).out
+IMAGE=$(NAME)
+VERSION = $(shell git describe --always --tags)
+all: clean
 	go build -o $(BUILD) -mod vendor
-start:
-	./$(BUILD) -conf config/config.yaml
+	./$(BUILD) -conf configs/config.yaml
 docker:
-	docker build -t ssaplayground:v0.1 -f docker/Dockerfile .
-update:
-	docker run -itd -v ~/dev/ssaplayground/data:/app/public/buildbox -p 6789:6789 ssaplayground:v0.1
+	docker build -t $(IMAGE):$(VERSION) -t $(IMAGE):latest -f docker/Dockerfile .
+run:
+	docker ps -a | grep $(NAME) && ([ $$? -eq 0 ] && (docker stop $(NAME) && docker rm -f $(NAME))) || echo "no running container."
+	docker run -itd -v $(shell pwd)/data:/app/public/buildbox -p 6789:6789 --name $(NAME) ssaplayground:latest
+tidy-docker:
+	docker ps -a | grep $(NAME)
+	[ $$? -eq 0 ] && docker stop $(NAME) && docker rm -f $(NAME)
+	docker images -f "dangling=true" -q | xargs docker rmi -f
+	docker image prune -f
 clean:
 	rm -rf $(BUILD)
 .PHONY: all start docker update clean

README.md

@@ -6,6 +6,30 @@ A tool for exploring go ssa intermediate representation.
 
 ![](./public/assets/screen.png)
 
+## Deployment
+
+There are two approaches to use the SSA Playground: native execution
+or Docker-based deployment.
+
+To execute natively, you can just use:
+
+```bash
+$ make
+```
+
+If you have Docker, then you can use:
+
+```bash
+$ make docker # build the docker image
+$ make run    # run/update for latest image
+```
+
+Then access http://localhost:6789/gossa.
+
+## Contribution
+
+We would love to hear your feedback. Submit [an issue](https://github.com/changkun/ssaplayground/issues/new) to tell bugs or feature requests.
+
 ## License
 
 GNU GPLv3 © [Changkun Ou](https://changkun.de)

configs/config.yaml

@@ -0,0 +1,4 @@
+---
+addr: localhost:6789
+mode: debug
+static: public

config/config.yaml configs/docker.yamlconfig/config.yaml renamed to configs/docker.yaml

@@ -1,4 +1,4 @@
 ---
 addr: 0.0.0.0:6789
-mode: debug
+mode: release
 static: public

docker/Dockerfile

@@ -1,2 +1,7 @@
-FROM alpine:latest
-
+FROM golang:1.14-alpine
+WORKDIR /app
+ADD . /app
+RUN go get -u golang.org/x/tools/cmd/goimports && go mod tidy
+RUN go build -o ssaplayground.service -mod vendor
+EXPOSE 6789
+ENTRYPOINT [ "/app/ssaplayground.service", "-conf=/app/configs/docker.yaml"]

public/assets/screen.png

@@ -0,0 +1 @@
+<!-- this is intended for empty -->