examples

Author: syphar

.docker.env.sample

@@ -0,0 +1,8 @@
+# environment overrides for the app instances running inside docker compose
+DOCSRS_LOG=docs_rs=debug,rustwide=info
+DOCSRS_INCLUDE_DEFAULT_TARGETS=false
+DOCSRS_DOCKER_IMAGE=ghcr.io/rust-lang/crates-build-env/linux-micro
+# To build with a PR that hasn't landed in a rust dist toolchain yet,
+# you can set this to the git sha of a try build:
+# https://forge.rust-lang.org/infra/docs/rustc-ci.html#try-builds
+DOCSRS_TOOLCHAIN=nightly

.env.sample

@@ -1,18 +1,25 @@
-export DOCSRS_PREFIX=ignored/cratesfyi-prefix
-export DOCSRS_DATABASE_URL=postgresql://cratesfyi:password@localhost:15432
+# environment overrides for local development outside docker.
+DOCSRS_PREFIX=ignored/cratesfyi-prefix
+DOCSRS_DATABASE_URL=postgresql://cratesfyi:password@localhost:15432
 
 # for local development with sqlx
-export DATABASE_URL=postgresql://cratesfyi:password@localhost:15432
+DATABASE_URL=postgresql://cratesfyi:password@localhost:15432
 
-export DOCSRS_LOG=docs_rs=debug,rustwide=info
+DOCSRS_LOG=docs_rs=debug,rustwide=info
+AWS_ACCESS_KEY_ID=cratesfyi
+AWS_SECRET_ACCESS_KEY=secret_key
+S3_ENDPOINT=http://localhost:9000
+DOCSRS_S3_STATIC_ROOT_PATH=http://localhost:9000/rust-docs-rs
+
+
+# build specific
+DOCSRS_INCLUDE_DEFAULT_TARGETS=false
+DOCSRS_DOCKER_IMAGE=ghcr.io/rust-lang/crates-build-env/linux-micro
+SENTRY_ENVIRONMENT=dev
 # To build with a PR that hasn't landed in a rust dist toolchain yet,
 # you can set this to the git sha of a try build:
 # https://forge.rust-lang.org/infra/docs/rustc-ci.html#try-builds
-export DOCSRS_TOOLCHAIN=nightly
-export AWS_ACCESS_KEY_ID=cratesfyi
-export AWS_SECRET_ACCESS_KEY=secret_key
-export S3_ENDPOINT=http://localhost:9000
-export DOCSRS_S3_STATIC_ROOT_PATH=http://localhost:9000/rust-docs-rs
-export DOCSRS_INCLUDE_DEFAULT_TARGETS=false
-export DOCSRS_DOCKER_IMAGE=ghcr.io/rust-lang/crates-build-env/linux-micro
-export SENTRY_ENVIRONMENT=dev
+DOCSRS_TOOLCHAIN=nightly
+
+# NOTE: when running services in docker-compose, you can override the settings in 
+# `.docker.env`, you'll fine an example in `.docker.env.sample`.

Justfile

@@ -3,15 +3,10 @@ set ignore-comments
 set dotenv-load := true
 set dotenv-override := true
 
-# some environment variables that are needed for _local_ commands
-# these are defaults that can be overwritten in your local .env file
-export DOCSRS_INCLUDE_DEFAULT_TARGETS := env("DOCSRS_INCLUDE_DEFAULT_TARGETS", "false")
-export DOCSRS_LOG := env("DOCSRS_LOG", "docs_rs=debug,rustwide=info")
-export RUST_BACKTRACE := env("RUST_BACKTRACE", "1")
+# minimal settings to run justfile recipes that don't just run docker, like `run-tests`.
+# Typically you will want to create your own `.env` file based on `.env.sample` for 
+# easier local development.
 export DOCSRS_PREFIX := env("DOCSRS_PREFIX", "ignored/cratesfyi-prefix")
-
-# database & s3 settings for local testing, to connect to the DB & S3/minio instance 
-# configured in docker-compose.yml
 export DOCSRS_DATABASE_URL := env("DOCSRS_DATABASE_URL", "postgresql://cratesfyi:password@localhost:15432")
 export AWS_ACCESS_KEY_ID := env("AWS_ACCESS_KEY_ID", "cratesfyi")
 export AWS_SECRET_ACCESS_KEY := env("AWS_SECRET_ACCESS_KEY", "secret_key")
@@ -20,7 +15,7 @@ export S3_ENDPOINT := env("S3_ENDPOINT", "http://localhost:9000")
 
 # List available commands
 _default:
-    just --list
+    @just --list
 
 import 'justfiles/cli.just'
 import 'justfiles/utils.just'

docker-compose.yml

@@ -69,33 +69,32 @@ x-healthcheck: &healthcheck-interval
     start_period: 10s
 
 x-environment: &environment
-    # FIXME: change to FOO: ${FOO:-default123 where these vars are just a 
-    # default that should be possible to override
-    RUST_BACKTRACE: true
-    DOCSRS_LOG: docs_rs=trace,tower_http=debug,rustwide=info,aws_smithy_http=trace,axum=debug
+    # default environment that can be overwritten in `.docker.env
+    RUST_BACKTRACE: ${RUST_BACKTRACE:-true}
+    DOCSRS_LOG: ${DOCSRS_LOG:-docs_rs=trace,tower_http=debug,rustwide=info,aws_smithy_http=trace,axum=debug}
 
+    # fixed environment to connect the different services in this file properly
     DOCSRS_PREFIX: /opt/docsrs/prefix
-
     DOCSRS_DATABASE_URL: postgresql://cratesfyi:password@db
     DOCSRS_MIN_POOL_IDLE: 1
     DOCSRS_MIN_POOL_SIZE: 2
     DOCSRS_MAX_POOL_SIZE: 10
-    DOCSRS_MAX_LEGACY_POOL_SIZE: 10
-
     DOCSRS_STORAGE_BACKEND: s3
-
     S3_ENDPOINT: http://s3:9000
     AWS_ACCESS_KEY_ID: cratesfyi
     AWS_SECRET_ACCESS_KEY: secret_key
 
 x-builder-environment: &builder-environment
     <<: *environment
+    # default builder environment that can be overwritten in `.docker.env
+    DOCSRS_INCLUDE_DEFAULT_TARGETS: ${DOCSRS_INCLUDE_DEFAULT_TARGETS:-false}
+    DOCSRS_DOCKER_IMAGE: ${DOCSRS_DOCKER_IMAGE:-ghcr.io/rust-lang/crates-build-env/linux-micro}
+
+    # fixed environment to connect the different services in this file properly
     DOCSRS_RUSTWIDE_WORKSPACE: /opt/docsrs/rustwide
     DOCSRS_COMPILER_METRICS_PATH: /opt/docsrs/prefix/metrics
     DOCSRS_DOCKER: true
-    DOCSRS_DOCKER_IMAGE: ghcr.io/rust-lang/crates-build-env/linux-micro
     DOCSRS_BUILD_CPU_LIMIT: 2
-    DOCSRS_INCLUDE_DEFAULT_TARGETS: false
 
 x-build: &build
     context: .
@@ -143,8 +142,7 @@ x-registry-watcher: &registry-watcher
         # Also on a native docker volume for performance
         REGISTRY_INDEX_PATH: /opt/docsrs/crates.io-index
         # configure the rebuild-queuer
-        DOCSRS_MAX_QUEUED_REBUILDS: 10
-
+        DOCSRS_MAX_QUEUED_REBUILDS: ${DOCSRS_MAX_QUEUED_REBUILDS:-10}
     env_file:
         - .docker.env
     healthcheck:
@@ -164,6 +162,7 @@ services:
         environment:
             <<: *environment
             DOCSRS_RENDER_THREADS: 2
+            DOCSRS_S3_STATIC_ROOT_PATH: http://localhost:9000/rust-docs-rs
         env_file:
             - .docker.env
         healthcheck: