adding database support - static builds are tricky

Author: elrido

.env

@@ -0,0 +1 @@
+DATABASE_URL=var/directory.sqlite

.gitignore

@@ -1,3 +1,4 @@
 /.cargo/
 /target/
 /TODO.md
+/var/geoip-country.mmdb

Cargo.lock

@@ -6,20 +6,29 @@ edition = "2018"
 
 [dependencies]
 dns-lookup = "1.0.1"
+dotenv = "0.15.0"
 hyper = "0.10.16"
 maxminddb = "0.13.0"
 regex = "1.3.6"
 rocket = "0.4.4"
 
+[dependencies.diesel]
+version = "1.4.4"
+features = ["sqlite"]
+
 [dependencies.hyper-sync-rustls]
 version = "0.3.0-rc.4"
 default-features = false
 features = ["client"]
 
+[dependencies.libsqlite3-sys]
+version = "0.17.1"
+features = ["bundled"]
+
 [dependencies.rocket_contrib]
 version = "0.4.4"
 default-features = false
-features = ["serve", "tera_templates"]
+features = ["diesel_sqlite_pool", "serve", "tera_templates"]
 
 [dependencies.serde]
 version = "1.0.105"

Cargo.toml

@@ -3,6 +3,8 @@ LABEL maintainer="support@privatebin.org"
 
 ARG GEOIP_MMDB
 ENV GEOIP_MMDB $GEOIP_MMDB
+ARG ROCKET_DATABASES
+ENV ROCKET_DATABASES $ROCKET_DATABASES
 ARG PORT
 EXPOSE $PORT
 USER 1000:1000
@@ -12,5 +14,6 @@ CMD ["directory"]
 
 COPY css /css
 COPY img /img
+COPY migrations /bin/migrations
 COPY target/x86_64-unknown-linux-musl/release/directory /bin/
 COPY templates /bin/templates

Dockerfile

@@ -4,35 +4,44 @@ NAME = directory
 IMAGE = privatebin/$(NAME)
 PORT = 8000
 GEOIP_MMDB=var/geoip-country.mmdb
+DATABASE=var/directory.sqlite
+ROCKET_DATABASES="{directory={url=\"$(DATABASE)\"}}"
 
 all: test build image run check clean ## Equivalent to "make test build image run check clean" (default).
 
 release: test build pack image run check clean ## Equivalent to "make test build pack image run check clean".
 
 test: .cargo/registry ## Build and run the unit tests.
-	docker run --rm -t --init -e GEOIP_MMDB="/home/rust/src/$(GEOIP_MMDB)" \
+	docker run --rm -t --init \
+		-e GEOIP_MMDB="$(GEOIP_MMDB)" \
+		-e ROCKET_DATABASES="$(ROCKET_DATABASES)" \
 		-v "$(CURDIR)":/home/rust/src \
 		-v "$(CURDIR)"/.cargo/registry:/home/rust/.cargo/registry \
-		ekidd/rust-musl-builder:nightly-2020-03-12 \
+		ekidd/rust-musl-builder:nightly-2020-03-12-sqlite \
 		cargo test --release # -- --nocapture
 
 build: .cargo/registry ## Build the binary for release.
-	docker run --rm -t --init -e GEOIP_MMDB="/home/rust/src/$(GEOIP_MMDB)" \
+	docker run --rm -t --init \
+		-e GEOIP_MMDB="$(GEOIP_MMDB)" \
+		-e ROCKET_DATABASES="$(ROCKET_DATABASES)" \
 		-v "$(CURDIR)":/home/rust/src \
 		-v "$(CURDIR)"/.cargo/registry:/home/rust/.cargo/registry \
-		ekidd/rust-musl-builder:nightly-2020-03-12 \
+		ekidd/rust-musl-builder:nightly-2020-03-12-sqlite \
 		cargo build --release
 
 pack: ## Strips and compresses the binary to reduce it's size, only intended for the release.
 	strip target/x86_64-unknown-linux-musl/release/directory
 	upx --ultra-brute target/x86_64-unknown-linux-musl/release/directory
 
 image: ## Build the container image.
-	docker build --build-arg PORT=$(PORT) --build-arg GEOIP_MMDB="/$(GEOIP_MMDB)" -t $(IMAGE) .
+	docker build --build-arg PORT=$(PORT) \
+		--build-arg GEOIP_MMDB="/$(GEOIP_MMDB)" \
+		--build-arg ROCKET_DATABASES='{directory={url="/'$(DATABASE)'"}}' \
+		-t $(IMAGE) .
 
 run: ## Run a container from the image.
 	docker run -d --init --name $(NAME) -p=$(PORT):$(PORT) \
-	   --read-only -v "$(CURDIR)":/var:ro --restart=always $(IMAGE)
+		--read-only -v "$(CURDIR)/var":/var --restart=always $(IMAGE)
 
 check: ## Launch tests to verify that the service works as expected, requires a running container.
 	@sleep 1
@@ -46,6 +55,7 @@ check: ## Launch tests to verify that the service works as expected, requires a
 clean: ## Stops and removes the running container.
 	docker stop $(NAME)
 	docker rm $(NAME)
+	git checkout $(DATABASE)
 
 help: ## Displays these usage instructions.
 	@echo "Usage: make <target(s)>"

Makefile

@@ -1,11 +1,19 @@
 # Directory
 
 Rust based directory application to collect lists of federated instances of a
-Software
+software.
+
+## Configuration
+
+The image supports the use of the following environment variables:
+
+- `GEOIP_MMDB`: path to the GeoIP database, in MaxMind format
+- `ROCKET_DATABASES`: [database dict](https://api.rocket.rs/v0.4/rocket_contrib/databases/index.html#environment-variables)
+  for Diesel SQLite library integration into Rocket
 
 ## Volumes
 
-- `/data`: Data
+- `/var/directory.sqlite`: Database file, needs to be writeable
 - `/var/geoip-country.mmdb`: GeoIP database, country level is sufficient
 
 ## Network ports