Merge pull request #287 from neon-mmd/improve-comments-in-dockerfile-and-compose-file

🔧 Provide comments in the two files

Cargo.lock

@@ -3932,7 +3932,7 @@ dependencies = [
 
 [[package]]
 name = "websurfx"
-version = "0.24.4"
+version = "1.0.0"
 dependencies = [
  "actix-cors",
  "actix-files",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "websurfx"
-version = "0.24.4"
+version = "1.0.0"
 edition = "2021"
 description = "An open-source alternative to Searx that provides clean, ad-free, and organic results with incredible speed while keeping privacy and security in mind."
 repository = "https://github.com/neon-mmd/websurfx"

Dockerfile

@@ -12,11 +12,25 @@ RUN cargo chef prepare --recipe-path recipe.json
 FROM chef AS builder
 COPY --from=planner /app/recipe.json recipe.json
 # Build dependencies - this is the caching Docker layer!
+# Uncomment the line below if you want to use the `hybrid` caching feature.
+# RUN cargo chef cook --release --features redis-cache --recipe-path recipe.json
+# Comment the line below if you don't want to use the `In-Memory` caching feature.
 RUN cargo chef cook --release --recipe-path recipe.json
+# Uncomment the line below if you want to use the `no cache` feature.
+# RUN cargo chef cook --release --no-default-features --recipe-path recipe.json
+# Uncomment the line below if you want to use the `redis` caching feature.
+# RUN cargo chef cook --release --no-default-features --features redis-cache --recipe-path recipe.json
 
 # Build application
 COPY . .
+# Uncomment the line below if you want to use the `hybrid` caching feature.
+# RUN cargo install --path . --features redis-cache
+# Comment the line below if you don't want to use the `In-Memory` caching feature.
 RUN cargo install --path .
+# Uncomment the line below if you want to use the `no cache` feature.
+# RUN cargo install --path . --no-default-features 
+# Uncomment the line below if you want to use the `redis` caching feature.
+# RUN cargo install --path . --no-default-features --features redis-cache
 
 # We do not need the Rust toolchain to run the binary!
 FROM gcr.io/distroless/cc-debian12

docker-compose.yml

@@ -6,13 +6,15 @@ services:
     build: .
     ports:
       - 8080:8080
-    depends_on:
+    # Uncomment the following lines if you are using the `hybrid` or `redis` caching feature.
-      - redis
+    # depends_on:
-    links:
+    #   - redis
-      - redis
+    # links:
+    #   - redis
     volumes:
       - ./websurfx/:/etc/xdg/websurfx/
-  redis:
+  # Uncomment the following lines if you are using the `hybrid` or `redis` caching feature.
-    image: redis:latest
+  # redis:
-    ports:
+  #   image: redis:latest
-      - 6379:6379
+  #   ports:
+  #     - 6379:6379