Commit ae5bc3ae authored by Cecylia Bocovich's avatar Cecylia Bocovich 💬
Browse files

Updated README and added makefile to ease updates

parent 457f0fa9
Loading
Loading
Loading
Loading

Makefile

0 → 100644
+21 −0
Original line number Diff line number Diff line
IMAGE=thetorproject/snowflake-proxy

.PHONY: tag
tag:
	@[ "${VERSION}" ] || ( echo "Env var VERSION is not set."; exit 1 )
	docker tag $(IMAGE) $(IMAGE):$(VERSION)
	docker tag $(IMAGE) $(IMAGE):latest

.PHONY: release
release:
	@[ "${VERSION}" ] || ( echo "Env var VERSION is not set."; exit 1 )
	docker push $(IMAGE):$(VERSION)
	docker push $(IMAGE):latest

.PHONY: build
build:
	docker build -t $(IMAGE) .

.PHONY: deploy
deploy:
	docker-compose up -d snowflake-proxy
+19 −5
Original line number Diff line number Diff line
#### Building and Running:
#### To run this docker container:
``` 
docker-compose up
docker-compose up -d
```

#### To Re-build and Run:
#### Releasing a new image
First, build the image:
```
docker-compose up --build 
make build
```
Next, release a new version by adding a tag:
```
make tag VERSION=X.Y
```
Finally, release the image:
```
make release VERSION=X.Y
```
Once we released a new image version, we tag the respective git commit:
```
git tag -a -s "vVERSION" -m "Docker image version VERSION"
git push --tags origin main
```

#### Adding Custom URLs: