repo_name stringlengths 1 62 | dataset stringclasses 1 value | lang stringclasses 11 values | pr_id int64 1 20.1k | owner stringlengths 2 34 | reviewer stringlengths 2 39 | diff_hunk stringlengths 15 262k | code_review_comment stringlengths 1 99.6k |
|---|---|---|---|---|---|---|---|
timefold-quickstarts | github_2023 | others | 36 | TimefoldAI | rsynek | @@ -0,0 +1,129 @@
+name: Release
+on:
+ workflow_dispatch:
+ inputs:
+ version:
+ description: 'Community Edition version (e.g. 1.0.0)'
+ required: true
+ developmentBranch:
+ description: 'Development branch to cut the release from'
+ default: development
+ required: true
+ stableBranch:
+ description: 'Stable branch to merge the development branch into'
+ default: stable
+ required: true
+ releaseBranch:
+ description: 'Release branch to create (e.g. 1.0.x for version 1.0.0; once created, branch protection rules apply)'
+ default: dry_run
+ required: true
+ nextVersion:
+ description: 'Next version after release (e.g. 1.1.0, -SNAPSHOT will be added automatically)'
+ required: true
+ nextMicroVersion:
+ description: 'Next version after release for release branch (e.g. 1.0.1, -SNAPSHOT will be added automatically)'
+ required: true
+jobs:
+ build:
+ env:
+ MAVEN_ARGS: "--no-transfer-progress --batch-mode"
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout the relevant timefold-solver tag
+ uses: actions/checkout@v3
+ with:
+ repository: "TimefoldAI/timefold-solver"
+ path: "./timefold-solver"
+ fetch-depth: 0
+ ref: v${{ github.event.inputs.version }}
+
+ - uses: actions/setup-java@v3
+ with:
+ java-version: '17'
+ distribution: 'temurin'
+ cache: 'maven'
+
+ # No need to wait for the upstream release to show up in Maven Central.
+ - name: Build the upstream release tag
+ working-directory: "./timefold-solver"
+ run: |
+ mvn -Dquickly install
+ cd ..
+ rm -rf timefold-solver
+
+ - name: Checkout timefold-quickstarts
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ - name: Create release branch and switch to it
+ run: |
+ git config user.name "Timefold Release Bot"
+ git config user.email "release@timefold.ai"
+ git checkout -B ${{ github.event.inputs.releaseBranch }}
+
+ # We do not use versions:set, because we'd have to have the SNAPSHOT version built from somewhere,
+ # and at this point in the release, there is no upstream branch anywhere that would have this version anymore.
+ - name: Set release version and build release
+ run: |
+ DETECTED_VERSION=$(mvn -q \ | There is a better way of getting the project version; see the accepted answer:
https://stackoverflow.com/questions/3545292/how-to-get-maven-project-version-to-the-bash-command-line |
timefold-quickstarts | github_2023 | others | 36 | TimefoldAI | rsynek | @@ -0,0 +1,129 @@
+name: Release
+on:
+ workflow_dispatch:
+ inputs:
+ version:
+ description: 'Community Edition version (e.g. 1.0.0)'
+ required: true
+ developmentBranch:
+ description: 'Development branch to cut the release from'
+ default: development
+ required: true
+ stableBranch:
+ description: 'Stable branch to merge the development branch into'
+ default: stable
+ required: true
+ releaseBranch:
+ description: 'Release branch to create (e.g. 1.0.x for version 1.0.0; once created, branch protection rules apply)'
+ default: dry_run
+ required: true
+ nextVersion:
+ description: 'Next version after release (e.g. 1.1.0, -SNAPSHOT will be added automatically)'
+ required: true
+ nextMicroVersion:
+ description: 'Next version after release for release branch (e.g. 1.0.1, -SNAPSHOT will be added automatically)'
+ required: true
+jobs:
+ build:
+ env:
+ MAVEN_ARGS: "--no-transfer-progress --batch-mode"
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout the relevant timefold-solver tag
+ uses: actions/checkout@v3
+ with:
+ repository: "TimefoldAI/timefold-solver"
+ path: "./timefold-solver"
+ fetch-depth: 0
+ ref: v${{ github.event.inputs.version }}
+
+ - uses: actions/setup-java@v3
+ with:
+ java-version: '17'
+ distribution: 'temurin'
+ cache: 'maven'
+
+ # No need to wait for the upstream release to show up in Maven Central.
+ - name: Build the upstream release tag
+ working-directory: "./timefold-solver"
+ run: |
+ mvn -Dquickly install
+ cd ..
+ rm -rf timefold-solver
+
+ - name: Checkout timefold-quickstarts
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ - name: Create release branch and switch to it
+ run: |
+ git config user.name "Timefold Release Bot"
+ git config user.email "release@timefold.ai"
+ git checkout -B ${{ github.event.inputs.releaseBranch }}
+
+ # We do not use versions:set, because we'd have to have the SNAPSHOT version built from somewhere,
+ # and at this point in the release, there is no upstream branch anywhere that would have this version anymore.
+ - name: Set release version and build release
+ run: |
+ DETECTED_VERSION=$(mvn -q \
+ -Dexec.executable="echo" \
+ -Dexec.args='${project.version}' \
+ --non-recursive \
+ org.codehaus.mojo:exec-maven-plugin:1.6.0:exec \
+ )
+ find -name "pom.xml" | xargs sed -i "s/$DETECTED_VERSION/${{ github.event.inputs.version }}/g"
+ find -name "build.gradle" | xargs sed -i "s/$DETECTED_VERSION/${{ github.event.inputs.version }}/g"
+ mvn -Dfull test
+ find -name "pom.xml" | xargs git add
+ find -name "build.gradle" | xargs git add
+ git commit -m "chore: release version ${{ github.event.inputs.version }}" | The version replacement deserves a standalone script; especially if we repeat the same steps for the micro version below. |
timefold-quickstarts | github_2023 | others | 24 | TimefoldAI | ge0ffrey | @@ -167,6 +167,65 @@
<quarkus.package.type>native</quarkus.package.type>
</properties>
</profile>
+ <profile>
+ <id>container</id>
+ <activation>
+ <property>
+ <name>container</name>
+ </property>
+ </activation>
+ <properties>
+ <container.runtime>podman</container.runtime>
+ </properties>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <descriptors>
+ <descriptor>src/main/assembly/assembly-timefold-quickstarts.xml</descriptor>
+ </descriptors>
+ <finalName>container-content</finalName>
+ <appendAssemblyId>false</appendAssemblyId>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>exec-maven-plugin</artifactId> | Is there a specialized docker maven plugin (the jib plugin maybe?) who can reduce the boilerplate in this exec approach, and avoid relying on installed programs in the environment? |
timefold-quickstarts | github_2023 | others | 24 | TimefoldAI | ge0ffrey | @@ -0,0 +1,31 @@
+#!/bin/sh
+
+# Change directory to the directory of the script
+cd "$(dirname $0)" || exit
+
+jvmOptions="-Xms128m -Xmx512m -Dstartup-open-browser=true"
+mainJar="quickstarts/binaries/quarkus-app/quarkus-run.jar"
+
+echo "Usage: ./runQuickstarts.sh"
+echo "Notes:"
+echo "- Java 11 or higher must be installed. Get the latest OpenJDK from (https://adoptium.net/)." | We're minimum java 17 |
timefold-quickstarts | github_2023 | others | 27 | TimefoldAI | triceo | @@ -106,11 +106,6 @@
<version>5.2.3</version>
<scope>runtime</scope>
</dependency>
- <dependency>
- <groupId>org.webjars</groupId>
- <artifactId>popper.js</artifactId>
- <version>1.16.0</version> | Are you entirely sure about this?
JQuery typically brings this, but there is no way to check that it does unless you've actually checked that dropdowns work in the UI. |
timefold-quickstarts | github_2023 | java | 27 | TimefoldAI | triceo | @@ -62,9 +62,9 @@ public String solve(VehicleRoutePlan problem) {
jobId_ -> jobIdToJob.get(jobId).routePlan,
solution -> jobIdToJob.put(jobId, Job.newRoutePlan(solution)),
(jobId_, exception) -> {
- jobIdToJob.put(jobId, Job.error(jobId_, exception));
- LOGGER.error("Failed solving jobId ({}).", jobId, exception);}
- );
+ jobIdToJob.put(jobId, Job.error(jobId_, exception));
+ LOGGER.error("Failed solving jobId ({}).", jobId, exception);
+ }); | How did this escape auto-formatting in CI? |
timefold-quickstarts | github_2023 | others | 27 | TimefoldAI | triceo | @@ -29,7 +29,7 @@ quarkus.log.category."ai.timefold.solver".level=DEBUG
%prod.quarkus.log.category."ai.timefold.solver".level=INFO
# XML file for power tweaking, defaults to solverConfig.xml (directly under src/main/resources)
-# quarkus.timefold.solver-config-xml=org/.../timeTableSolverConfig.xml
+# quarkus.timefold.solver-config-xml=org/.../timetableSolverConfig.xml | I see property change, but no file name change in the PR.
Does that mean the file doesn't exist and this is just an example? |
timefold-quickstarts | github_2023 | javascript | 27 | TimefoldAI | triceo | @@ -322,15 +275,15 @@ function replaceQuickstartTimefoldAutoHeaderFooter() {
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNav">
- <ul class="navbar-nav">
+ <ul class="nav nav-pills"> | I absolutely hate that this happens in JS.
Without JS, this simply doesn't happen. Key parts of the UI are not going to be there.
*This is wrong*. (Unfortunately, it is not new.) |
timefold-quickstarts | github_2023 | java | 26 | TimefoldAI | ge0ffrey | @@ -0,0 +1,170 @@
+package org.acme.vehiclerouting.domain;
+
+import java.util.List;
+import java.util.stream.Stream;
+
+import ai.timefold.solver.core.api.domain.solution.PlanningEntityCollectionProperty;
+import ai.timefold.solver.core.api.domain.solution.PlanningScore;
+import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
+import ai.timefold.solver.core.api.domain.solution.ProblemFactCollectionProperty;
+import ai.timefold.solver.core.api.domain.valuerange.ValueRangeProvider;
+import ai.timefold.solver.core.api.score.buildin.hardsoftlong.HardSoftLongScore;
+import ai.timefold.solver.core.api.solver.SolverStatus;
+
+import org.acme.vehiclerouting.domain.geo.DistanceCalculator;
+import org.acme.vehiclerouting.domain.geo.EuclideanDistanceCalculator;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@PlanningSolution
+public class VehicleRoutePlan {
+
+ private String name;
+
+ @JsonIgnore
+ private List<Location> locations;
+
+ @ProblemFactCollectionProperty
+ private List<Depot> depots;
+
+ @PlanningEntityCollectionProperty
+ private List<Vehicle> vehicles;
+
+ @ProblemFactCollectionProperty
+ @ValueRangeProvider
+ private List<Customer> customers;
+
+ @PlanningScore
+ private HardSoftLongScore score;
+
+ private Location southWestCorner;
+ private Location northEastCorner;
+
+ private SolverStatus solverStatus;
+
+ private String scoreExplanation; | Interesting and good! This is a step forward, so let's add this indeed, but I do think we need a broader discussion to figure out the best way to do this. |
timefold-quickstarts | github_2023 | java | 26 | TimefoldAI | ge0ffrey | @@ -5,21 +5,22 @@
import java.util.Comparator;
+import ai.timefold.solver.core.impl.heuristic.selector.common.decorator.SelectionSorterWeightFactory;
+
import org.acme.vehiclerouting.domain.Customer;
import org.acme.vehiclerouting.domain.Depot;
-import org.acme.vehiclerouting.domain.VehicleRoutingSolution;
-import ai.timefold.solver.core.impl.heuristic.selector.common.decorator.SelectionSorterWeightFactory;
+import org.acme.vehiclerouting.domain.VehicleRoutePlan;
/**
* On large datasets, the constructed solution looks like pizza slices.
*/
public class DepotAngleCustomerDifficultyWeightFactory
- implements SelectionSorterWeightFactory<VehicleRoutingSolution, Customer> {
+ implements SelectionSorterWeightFactory<VehicleRoutePlan, Customer> {
@Override
- public DepotAngleCustomerDifficultyWeight createSorterWeight(VehicleRoutingSolution vehicleRoutingSolution,
- Customer customer) {
- Depot depot = vehicleRoutingSolution.getDepotList().get(0);
+ public DepotAngleCustomerDifficultyWeight createSorterWeight(VehicleRoutePlan vehicleRoutePlan,
+ Customer customer) { | (very soft) Weird code style? |
timefold-quickstarts | github_2023 | java | 26 | TimefoldAI | ge0ffrey | @@ -0,0 +1,30 @@
+package org.acme.vehiclerouting.rest;
+
+import jakarta.ws.rs.core.Response;
+
+public class VehicleRoutingSolverException extends RuntimeException { | I am ok with adding it for now, but I believe that custom Exceptions and ExeptionMapper etc are overkill for quickstarts. Less code is more easier to grok for users that quick start. |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -32,26 +34,36 @@ public class TimeTable {
public TimeTable() {
}
- public TimeTable(List<Timeslot> timeslotList, List<Room> roomList, List<Lesson> lessonList) {
- this.timeslotList = timeslotList;
- this.roomList = roomList;
- this.lessonList = lessonList;
+ public TimeTable(HardSoftScore score, SolverStatus solverStatus) { | The "status only" version could probably use the name field too |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -0,0 +1,217 @@
+package org.acme.schooltimetabling.service;
+
+import java.time.DayOfWeek;
+import java.time.LocalTime;
+import java.util.ArrayList;
+import java.util.List;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import org.acme.schooltimetabling.domain.Lesson;
+import org.acme.schooltimetabling.domain.Room;
+import org.acme.schooltimetabling.domain.TimeTable;
+import org.acme.schooltimetabling.domain.Timeslot;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+
+@Tag(name = "Demo data sets", description = "Timefold-provided demo school timetable data sets.")
+@Path("demo/datasets")
+public class TimeTableDemoResource {
+
+ public enum DemoDataSet {
+ SMALL,
+ LARGE
+ }
+
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "List of demo data sets represented as IDs.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = DemoDataSet.class, type = SchemaType.ARRAY))) })
+ @Operation(summary = "List demo data sets.")
+ @GET
+ public DemoDataSet[] list() {
+ return DemoDataSet.values();
+ }
+
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "Unsolved demo timetable.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = TimeTable.class))),
+ @APIResponse(responseCode = "404", description = "Demo data set does not exist.",
+ content = @Content(mediaType = MediaType.TEXT_PLAIN))})
+ @Operation(summary = "Find an unsolved demo timetable by ID.")
+ @GET
+ @Path("/{id}")
+ public Response generate(@Parameter(description = "Unique identifier of the demo data set.",
+ required = true) @PathParam("id") String dataSetId) { | Nitpick: I prefer to keep the java parameter name and the url parameter the same name if they are the same
```suggestion
@Path("/{dataSetId}")
public Response generate(@Parameter(description = "Unique identifier of the demo data set.",
required = true) @PathParam("dataSetId") String dataSetId) {
``` |
timefold-quickstarts | github_2023 | others | 18 | TimefoldAI | ge0ffrey | @@ -9,170 +9,117 @@
<link rel="icon" href="/webjars/timefold/img/timefold-favicon.svg" type="image/svg+xml">
</head>
<body>
-<header id="timefold-auto-header"></header>
-<div class="container">
- <div class="sticky-top d-flex justify-content-center align-items-center" aria-live="polite" aria-atomic="true">
- <div id="notificationPanel" style="position: absolute; top: .5rem;"></div>
- </div>
- <h1>High school time table solver</h1>
- <p>Generate the optimal schedule for your teachers and students.</p>
-
- <div class="mb-2">
- <button id="refreshButton" type="button" class="btn btn-secondary">
- <span class="fas fa-refresh"></span> Refresh
- </button>
- <button id="solveButton" type="button" class="btn btn-success">
- <span class="fas fa-play"></span> Solve
- </button>
- <button id="stopSolvingButton" type="button" class="btn btn-danger">
- <span class="fas fa-stop"></span> Stop solving
- </button>
- <span id="score" class="score ms-2 align-middle fw-bold">Score: ?</span>
-
- <div class="float-end">
- <ul class="nav nav-pills" role="tablist">
- <li class="nav-item" role="presentation">
- <button class="nav-link active" id="byRoomTab" data-bs-toggle="tab" data-bs-target="#byRoomPanel" type="button" role="tab" aria-controls="byRoomPanel" aria-selected="true">By room</button>
- </li>
- <li class="nav-item" role="presentation">
- <button class="nav-link" id="byTeacherTab" data-bs-toggle="tab" data-bs-target="#byTeacher" type="button" role="tab" aria-controls="byTeacher" aria-selected="false">By teacher</button>
- </li>
- <li class="nav-item" role="presentation">
- <button class="nav-link" id="byStudentGroupTab" data-bs-toggle="tab" data-bs-target="#byStudentGroup" type="button" role="tab" aria-controls="byStudentGroup" aria-selected="false">By student group</button>
- </li>
- </ul>
- </div>
- </div>
- <div class="tab-content">
- <div class="tab-pane fade show active" id="byRoomPanel" role="tabpanel" aria-labelledby="byRoomTab">
- <table class="table table-borderless table-striped" id="timeTableByRoom">
- <!-- Filled in by app.js -->
- </table>
- </div>
- <div class="tab-pane fade" id="byTeacher" role="tabpanel" aria-labelledby="byTeacherTab">
- <table class="table table-borderless table-striped" id="timeTableByTeacher">
- <!-- Filled in by app.js -->
- </table>
- </div>
- <div class="tab-pane fade" id="byStudentGroup" role="tabpanel" aria-labelledby="byStudentGroupTab">
- <table class="table table-borderless table-striped" id="timeTableByStudentGroup">
- <!-- Filled in by app.js -->
- </table>
+ <header id="timefold-auto-header">
+ <!-- Filled in by app.js -->
+ </header>
+ <div id="demo" class="container">
+ <div class="sticky-top d-flex justify-content-center align-items-center" aria-live="polite" aria-atomic="true">
+ <div id="notificationPanel" style="position: absolute; top: .5rem;"></div>
</div>
- </div>
- <div class="mb-4">
- <button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#lessonDialog">
- <span class="fas fa-plus"></span> Add lesson
- </button>
- <button type="button" class="btn btn-secondary" data-bs-toggle="modal" data-bs-target="#timeslotDialog">
- <span class="fas fa-plus"></span> Add timeslot
- </button>
- <button type="button" class="btn btn-secondary" data-bs-toggle="modal" data-bs-target="#roomDialog">
- <span class="fas fa-plus"></span> Add room
- </button>
- </div>
-
- <h2>Unassigned lessons</h2>
- <div id="unassignedLessons" class="row row-cols-3 g-3 mb-4"></div>
-</div>
-<footer id="timefold-auto-footer"></footer>
+ <h1>High school timetable solver</h1>
+ <p>Generate the optimal schedule for your teachers and students.</p>
+ <div class="mb-2">
+ <button id="solveButton" type="button" class="btn btn-success">
+ <span class="fas fa-play"></span> Solve
+ </button>
+ <button id="stopSolvingButton" type="button" class="btn btn-danger">
+ <span class="fas fa-stop"></span> Stop solving
+ </button>
+ <span id="score" class="score ms-2 align-middle fw-bold">Score: ?</span>
-<div class="modal fade" id="lessonDialog" tabindex="-1" role="dialog">
- <div class="modal-dialog" role="dialog">
- <div class="modal-content">
- <div class="modal-header">
- <h4>Add a lesson</h4>
- <button type="button" class="close" data-bs-dismiss="modal">
- <span>×</span>
- </button>
- </div>
- <div class="modal-body">
- <div class="form-group">
- <label for="lesson_subject">Subject</label>
- <input type="text" class="form-control" id="lesson_subject" required value="Music">
- </div>
- <div class="form-group">
- <label for="lesson_teacher">Teacher</label>
- <input type="text" class="form-control" id="lesson_teacher" required value="B. May">
- </div>
- <div class="form-group">
- <label for="lesson_studentGroup">Student group</label>
- <input type="text" class="form-control" id="lesson_studentGroup" required value="11th grade">
- </div>
- <div class="modal-footer">
- <button type="button" class="btn btn-default" data-bs-dismiss="modal">Cancel</button>
- <button type="button" class="btn btn-primary" id="addLessonSubmitButton">Submit new lesson</button>
- </div>
+ <div class="float-end">
+ <ul class="nav nav-pills" role="tablist">
+ <li class="nav-item" role="presentation">
+ <button class="nav-link active" id="byRoomTab" data-bs-toggle="tab" data-bs-target="#byRoomPanel" type="button" role="tab" aria-controls="byRoomPanel" aria-selected="true">By room</button>
+ </li>
+ <li class="nav-item" role="presentation">
+ <button class="nav-link" id="byTeacherTab" data-bs-toggle="tab" data-bs-target="#byTeacher" type="button" role="tab" aria-controls="byTeacher" aria-selected="false">By teacher</button>
+ </li>
+ <li class="nav-item" role="presentation">
+ <button class="nav-link" id="byStudentGroupTab" data-bs-toggle="tab" data-bs-target="#byStudentGroup" type="button" role="tab" aria-controls="byStudentGroup" aria-selected="false">By student group</button>
+ </li>
+ </ul>
</div>
</div>
- </div>
-</div>
-<div class="modal fade" id="timeslotDialog" tabindex="-1" role="dialog">
- <div class="modal-dialog" role="dialog">
- <div class="modal-content">
- <div class="modal-header">
- <h4>Add a timeslot</h4>
- <button type="button" class="close" data-bs-dismiss="modal">
- <span>×</span>
- </button>
+ <div class="tab-content">
+ <div class="tab-pane fade show active" id="byRoomPanel" role="tabpanel" aria-labelledby="byRoomTab">
+ <table class="table table-borderless table-striped" id="timeTableByRoom">
+ <!-- Filled in by app.js -->
+ </table>
+ </div>
+ <div class="tab-pane fade" id="byTeacher" role="tabpanel" aria-labelledby="byTeacherTab">
+ <table class="table table-borderless table-striped" id="timeTableByTeacher">
+ <!-- Filled in by app.js -->
+ </table>
</div>
- <div class="modal-body">
- <div class="form-group">
- <label for="timeslot_dayOfWeek">Day of week</label>
- <select class="form-control" id="timeslot_dayOfWeek" required>
- <option>Monday</option>
- <option>Tuesday</option>
- <option selected="selected">Wednesday</option>
- <option>Thursday</option>
- <option>Friday</option>
- <option>Saturday</option>
- <option>Sunday</option>
- </select>
- </div>
- <div class="form-group">
- <label for="timeslot_startTime">Start time</label>
- <input type="time" class="form-control" id="timeslot_startTime" required value="08:30"/>
- </div>
- <div class="form-group">
- <label for="timeslot_endTime">End time</label>
- <input type="time" class="form-control" id="timeslot_endTime" required value="09:30">
- </div>
- <div class="modal-footer">
- <button type="button" class="btn btn-default" data-bs-dismiss="modal">Cancel</button>
- <button type="button" class="btn btn-primary" id="addTimeslotSubmitButton">Submit new timeslot</button>
- </div>
+ <div class="tab-pane fade" id="byStudentGroup" role="tabpanel" aria-labelledby="byStudentGroupTab">
+ <table class="table table-borderless table-striped" id="timeTableByStudentGroup">
+ <!-- Filled in by app.js -->
+ </table>
</div>
</div>
+
+ <h2>Unassigned lessons</h2>
+ <div id="unassignedLessons" class="row row-cols-3 g-3 mb-4"></div>
</div>
-</div>
-<div class="modal fade" id="roomDialog" tabindex="-1" role="dialog">
- <div class="modal-dialog" role="dialog">
- <div class="modal-content">
- <div class="modal-header">
- <h4>Add a room</h4>
- <button type="button" class="close" data-bs-dismiss="modal">
- <span>×</span>
- </button>
- </div>
- <div class="modal-body">
- <div class="form-group">
- <label for="room_name">Name</label>
- <input type="text" class="form-control" id="room_name" required value="Room D">
- </div>
- <div class="modal-footer">
- <button type="button" class="btn btn-default" data-bs-dismiss="modal">Cancel</button>
- <button type="button" class="btn btn-primary" id="addRoomSubmitButton">Submit new room</button>
- </div>
- </div>
+
+ <div id="rest" class="container-fluid d-none">
+ <h1>REST API Guide</h1>
+
+ <h2>High school timetable solver integration via cURL</h2>
+
+ <h3>1. Download sample data set</h3>
+ <pre>
+ <button class="btn btn-outline-dark btn-sm float-end"
+ onclick="textToClipboard('curl1')">Copy</button>
+ <code id="curl1">curl -X GET -H 'Accept:application/json' http://localhost:8080/demo/datasets/SMALL -o sample.json</code>
+ </pre>
+
+ <h3>2. Post the sample data for solving</h3>
+ <p>The POST operation returns a <code>jobId</code> that should be used in subsequent commands.</p>
+ <pre>
+ <button class="btn btn-outline-dark btn-sm float-end"
+ onclick="textToClipboard('curl2')">Copy</button>
+ <code id="curl2">curl -X POST -H 'Content-Type:application/json' http://localhost:8080/timetables -d@sample.json</code>
+ </pre>
+
+ <h3>3. Get the current status and score</h3>
+ <pre>
+ <button class="btn btn-outline-dark btn-sm float-end"
+ onclick="textToClipboard('curl3')">Copy</button>
+ <code id="curl3">curl -X GET -H 'Accept:application/json' http://localhost:8080/timetables/{jobId}?retrieve=STATUS</code>
+ </pre>
+
+ <h3>4. Get the complete solution</h3>
+ <pre>
+ <button class="btn btn-outline-dark btn-sm float-end"
+ onclick="textToClipboard('curl4')">Copy</button>
+ <code id="curl4">curl -X GET -H 'Accept:application/json' http://localhost:8080/timetables/{jobId}</code>
+ </pre>
+
+ <h3>5. Terminate solving early</h3>
+ <pre>
+ <button class="btn btn-outline-dark btn-sm float-end"
+ onclick="textToClipboard('curl5')">Copy</button>
+ <code id="curl5">curl -X DELETE -H 'Accept:application/json' http://localhost:8080/timetables/{id}</code>
+ </pre>
+ </div>
+
+ <div id="openapi" class="container-fluid d-none">
+ <h1>REST API Reference</h1>
+ <div class="ratio ratio-1x1">
+ <!-- "scrolling" attribute is obsolete, but e.g. Chrome does not support "overflow:hidden" -->
+ <iframe src="/q/swagger-ui" style="overflow:hidden;" scrolling="no"></iframe>
</div>
</div>
-</div>
-<script src="/webjars/jquery/jquery.min.js"></script>
-<script src="/webjars/bootstrap/js/bootstrap.min.js"></script>
-<script src="/webjars/js-joda/dist/js-joda.min.js"></script>
-<script src="/webjars/timefold/js/timefold-webui.js"></script>
-<script src="/app.js"></script>
+ <footer id="timefold-auto-footer"></footer>
+
+ <script src="/webjars/bootstrap/js/bootstrap.bundle.min.js"></script> | The bundle version is bad IIRC. But jquery needs to be first |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -22,24 +29,54 @@ public class TimeTableResourceTest {
@Test
public void solveDemoDataUntilFeasible() {
- given()
+ TimeTable testTimeTable = createTestTimeTable(); | Instead of creating a testdata one manually, can we get it from the demo data resource?
That way, that get's tested too (less chances the UI breaks) and any refactors in the model don't need changes in this file (= more maintenance friendly) |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -8,31 +8,58 @@
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
import org.acme.schooltimetabling.domain.Lesson;
import org.acme.schooltimetabling.domain.Room;
import org.acme.schooltimetabling.domain.TimeTable;
import org.acme.schooltimetabling.domain.Timeslot;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
-@Path("demo")
+@Tag(name = "Demo data sets", description = "Timefold-provided demo school time table data sets")
+@Path("demo/datasets")
public class TimeTableDemoResource {
- public enum DemoDataType {
+ public enum DemoDataSet {
SMALL,
LARGE
}
- // TODO openapi
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "List of demo data sets represented as IDs",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = DemoDataSet.class, type = SchemaType.ARRAY))) })
+ @Operation(summary = "List demo data sets")
@GET
- @Path("data-types")
- public DemoDataType[] list() {
- return DemoDataType.values();
+ @Path("ids")
+ public DemoDataSet[] list() {
+ return DemoDataSet.values();
}
- // TODO openapi
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "Unsolved demo time table",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = TimeTable.class))),
+ @APIResponse(responseCode = "404", description = "Demo data set does not exist",
+ content = @Content(mediaType = MediaType.TEXT_PLAIN))})
+ @Operation(summary = "Find an unsolved demo time table by ID")
@GET
- @Path("data/{demoDataType}")
- public TimeTable generate(@PathParam("demoDataType") DemoDataType demoDataType) {
- String name = demoDataType.name();
+ @Path("{dataSetId}")
+ public Response generate(@Parameter(description = "Unique identifier of the demo data set",
+ required = true) @PathParam("dataSetId") String dataSetId) {
+ DemoDataSet demoDataSet;
+ try {
+ demoDataSet = DemoDataSet.valueOf(dataSetId);
+ } catch (IllegalArgumentException illegalArgumentException) {
+ return Response.status(Response.Status.NOT_FOUND).entity("Demo data set " + dataSetId + " not found.").build(); | In the quickstarts, I wouldn't bother with Response objects. It just makes it more complex.
Just return TimeTable type and throw an IllegalArgumentException. Let the default exception handlers turn it into a 500 (which is good enough).
=> Less code to grok for users. |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -0,0 +1,217 @@
+package org.acme.schooltimetabling.service;
+
+import java.time.DayOfWeek;
+import java.time.LocalTime;
+import java.util.ArrayList;
+import java.util.List;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import org.acme.schooltimetabling.domain.Lesson;
+import org.acme.schooltimetabling.domain.Room;
+import org.acme.schooltimetabling.domain.TimeTable;
+import org.acme.schooltimetabling.domain.Timeslot;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+
+@Tag(name = "Demo data sets", description = "Timefold-provided demo school timetable data sets.")
+@Path("demo/datasets")
+public class TimeTableDemoResource {
+
+ public enum DemoDataSet {
+ SMALL,
+ LARGE
+ }
+
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "List of demo data sets represented as IDs.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = DemoDataSet.class, type = SchemaType.ARRAY))) })
+ @Operation(summary = "List demo data sets.")
+ @GET
+ public DemoDataSet[] list() {
+ return DemoDataSet.values();
+ }
+
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "Unsolved demo timetable.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = TimeTable.class))),
+ @APIResponse(responseCode = "404", description = "Demo data set does not exist.",
+ content = @Content(mediaType = MediaType.TEXT_PLAIN))})
+ @Operation(summary = "Find an unsolved demo timetable by ID.")
+ @GET
+ @Path("/{id}")
+ public Response generate(@Parameter(description = "Unique identifier of the demo data set.",
+ required = true) @PathParam("id") String dataSetId) {
+ DemoDataSet demoDataSet;
+ try {
+ demoDataSet = DemoDataSet.valueOf(dataSetId);
+ } catch (IllegalArgumentException illegalArgumentException) {
+ return Response.status(Response.Status.NOT_FOUND).entity("Demo data set " + dataSetId + " not found.").build(); | n the quickstarts, I wouldn't bother with Response objects. It just makes it more complex.
Just return TimeTable type and throw an IllegalArgumentException. Let the default exception handlers turn it into a 500 (which is good enough). No need to open API document what happens that case.
=> Less code to grok for users. |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -0,0 +1,165 @@
+package org.acme.schooltimetabling.service;
+
+import java.util.List;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+
+import ai.timefold.solver.core.api.solver.SolverManager;
+import ai.timefold.solver.core.api.solver.SolverStatus;
+import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import org.acme.schooltimetabling.domain.TimeTable;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Tag(name = "School Timetables", description = "School timetable service assigning lessons to rooms and timeslots.")
+@Path("timetables")
+public class TimeTableResource { | Fair, unless we can standarize the all solutions as the word "schedule". To be discussed later. (I think we might, but out of scope for this refactor). |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -0,0 +1,165 @@
+package org.acme.schooltimetabling.service;
+
+import java.util.List;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+
+import ai.timefold.solver.core.api.solver.SolverManager;
+import ai.timefold.solver.core.api.solver.SolverStatus;
+import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import org.acme.schooltimetabling.domain.TimeTable;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Tag(name = "School Timetables", description = "School timetable service assigning lessons to rooms and timeslots.")
+@Path("timetables")
+public class TimeTableResource {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(TimeTableResource.class);
+
+ private final SolverManager<TimeTable, String> solverManager;
+
+ private ConcurrentMap<String, Job> jobs = new ConcurrentHashMap<>();
+
+ // Workaround to make Quarkus CDI happy. Do not use.
+ public TimeTableResource() {
+ this.solverManager = null;
+ }
+
+ @Inject
+ public TimeTableResource(SolverManager<TimeTable, String> solverManager) {
+ this.solverManager = solverManager;
+ }
+
+ @Operation(summary = "List the job IDs of all submitted timetables.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "List of all job IDs.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(type = SchemaType.ARRAY, implementation = String.class))) })
+ @GET
+ @Produces(MediaType.APPLICATION_JSON)
+ public List<String> list() {
+ return jobs.keySet().stream().toList();
+ }
+
+ @Operation(summary = "Submit a timetable to start solving as soon as CPU resources are available.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200",
+ description = "The job ID. Use that ID to get the solution with the other methods.",
+ content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(implementation = String.class))) })
+ @POST
+ @Consumes({ MediaType.APPLICATION_JSON })
+ @Produces(MediaType.TEXT_PLAIN)
+ public String solve(TimeTable problem) {
+ String jobId = UUID.randomUUID().toString();
+ jobs.put(jobId, Job.newTimeTable(problem));
+ solverManager.solveAndListen(jobId,
+ jobId_ -> jobs.get(jobId).timeTable,
+ solution -> jobs.put(jobId, Job.newTimeTable(solution)),
+ (jobId_, exception) -> jobs.put(jobId, Job.error(jobId_, exception)));
+ return jobId;
+ }
+
+ @Operation(
+ summary = "Get the solution and score for a given job ID. This is the best solution so far, as it might still be running or not even started.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "The best solution of the timetable so far.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = TimeTable.class))),
+ @APIResponse(responseCode = "404", description = "No timetable found.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = ErrorInfo.class))),
+ @APIResponse(responseCode = "500", description = "Exception during solving a timetable.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = ErrorInfo.class)))
+ })
+ @GET
+ @Produces(MediaType.APPLICATION_JSON)
+ @Path("{jobId}")
+ public Response getTimeTable( | See my comment above. |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -0,0 +1,165 @@
+package org.acme.schooltimetabling.service;
+
+import java.util.List;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+
+import ai.timefold.solver.core.api.solver.SolverManager;
+import ai.timefold.solver.core.api.solver.SolverStatus;
+import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import org.acme.schooltimetabling.domain.TimeTable;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Tag(name = "School Timetables", description = "School timetable service assigning lessons to rooms and timeslots.")
+@Path("timetables")
+public class TimeTableResource {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(TimeTableResource.class);
+
+ private final SolverManager<TimeTable, String> solverManager;
+
+ private ConcurrentMap<String, Job> jobs = new ConcurrentHashMap<>();
+
+ // Workaround to make Quarkus CDI happy. Do not use.
+ public TimeTableResource() {
+ this.solverManager = null;
+ }
+
+ @Inject
+ public TimeTableResource(SolverManager<TimeTable, String> solverManager) {
+ this.solverManager = solverManager;
+ }
+
+ @Operation(summary = "List the job IDs of all submitted timetables.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "List of all job IDs.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(type = SchemaType.ARRAY, implementation = String.class))) })
+ @GET
+ @Produces(MediaType.APPLICATION_JSON)
+ public List<String> list() {
+ return jobs.keySet().stream().toList();
+ }
+
+ @Operation(summary = "Submit a timetable to start solving as soon as CPU resources are available.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200",
+ description = "The job ID. Use that ID to get the solution with the other methods.",
+ content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(implementation = String.class))) })
+ @POST
+ @Consumes({ MediaType.APPLICATION_JSON })
+ @Produces(MediaType.TEXT_PLAIN)
+ public String solve(TimeTable problem) {
+ String jobId = UUID.randomUUID().toString();
+ jobs.put(jobId, Job.newTimeTable(problem));
+ solverManager.solveAndListen(jobId,
+ jobId_ -> jobs.get(jobId).timeTable,
+ solution -> jobs.put(jobId, Job.newTimeTable(solution)),
+ (jobId_, exception) -> jobs.put(jobId, Job.error(jobId_, exception)));
+ return jobId;
+ }
+
+ @Operation(
+ summary = "Get the solution and score for a given job ID. This is the best solution so far, as it might still be running or not even started.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "The best solution of the timetable so far.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = TimeTable.class))),
+ @APIResponse(responseCode = "404", description = "No timetable found.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = ErrorInfo.class))),
+ @APIResponse(responseCode = "500", description = "Exception during solving a timetable.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = ErrorInfo.class)))
+ })
+ @GET
+ @Produces(MediaType.APPLICATION_JSON)
+ @Path("{jobId}")
+ public Response getTimeTable(
+ @Parameter(description = "The job ID returned by the POST method.") @PathParam("jobId") String jobId,
+ @QueryParam("retrieve") Retrieve retrieve) {
+ retrieve = retrieve == null ? Retrieve.FULL : retrieve;
+ Job job = jobs.get(jobId);
+ if (job == null) {
+ return Response.status(Response.Status.NOT_FOUND)
+ .entity(new ErrorInfo(jobId, "No timetable found."))
+ .build();
+ }
+ if (job.error != null) {
+ LOGGER.error("Exception during solving jobId ({}), message ({}).", jobId, job.error.getMessage(), job.error);
+ return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
+ .entity(new ErrorInfo(jobId, job.error.getMessage()))
+ .build();
+ }
+ TimeTable timeTable = job.timeTable;
+ SolverStatus solverStatus = solverManager.getSolverStatus(jobId);
+ if (retrieve == Retrieve.STATUS) {
+ return Response.ok(new TimeTable(timeTable.getScore(), solverStatus)).build();
+ }
+ timeTable.setSolverStatus(solverStatus);
+ return Response.ok(timeTable).build();
+ }
+
+ @Operation(
+ summary = "Terminate solving for a given job ID. Returns the best solution of the timetable so far, as it might still be running or not even started.")
+ @APIResponses(value = {
+ @APIResponse(responseCode = "200", description = "The best solution of the timetable so far.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = TimeTable.class))),
+ @APIResponse(responseCode = "404", description = "No timetable found.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = ErrorInfo.class))),
+ @APIResponse(responseCode = "500", description = "Exception during solving a timetable.",
+ content = @Content(mediaType = MediaType.APPLICATION_JSON,
+ schema = @Schema(implementation = ErrorInfo.class)))
+ })
+ @DELETE
+ @Produces(MediaType.APPLICATION_JSON)
+ @Path("{jobId}")
+ public Response terminateSolving(
+ @Parameter(description = "The job ID returned by the POST method.") @PathParam("jobId") String jobId,
+ @QueryParam("retrieve") Retrieve retrieve) {
+ solverManager.terminateEarly(jobId); | add `// TODO Replace with .terminateEarlyAndWait(... [, timeout]) <url-to-issue>` |
timefold-quickstarts | github_2023 | java | 18 | TimefoldAI | ge0ffrey | @@ -0,0 +1,165 @@
+package org.acme.schooltimetabling.service;
+
+import java.util.List;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+
+import ai.timefold.solver.core.api.solver.SolverManager;
+import ai.timefold.solver.core.api.solver.SolverStatus;
+import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import org.acme.schooltimetabling.domain.TimeTable;
+import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
+import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Tag(name = "School Timetables", description = "School timetable service assigning lessons to rooms and timeslots.")
+@Path("timetables")
+public class TimeTableResource {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(TimeTableResource.class);
+
+ private final SolverManager<TimeTable, String> solverManager;
+
+ private ConcurrentMap<String, Job> jobs = new ConcurrentHashMap<>(); | // TODO there is no time to live, so this map grows out of memory |
WuKongIM | github_2023 | go | 218 | WuKongIM | tangtaoit | @@ -356,6 +376,10 @@ func (w *webhook) sendWebhookForGRPC(event string, data []byte) error {
startNow := time.Now()
startTime := startNow.UnixNano() / 1000 / 1000
w.Debug("webhook grpc εΌε§θ―·ζ±", zap.String("event", event))
+ if !w.isEventFocused(event) { // ε¦ζδΈε
³ζ³¨δΊδ»Άε°±δΈθ΅°εθΎΉηζ¨ιι»θΎ
+ w.Debug("webHook grpc ιε
³ζ³¨δΊδ»ΆοΌδΈζ¨ι", zap.String("event", event)) | webHook η»δΈι½η¨webhook |
WuKongIM | github_2023 | go | 218 | WuKongIM | tangtaoit | @@ -387,6 +411,14 @@ func (w *webhook) sendWebhookForGRPC(event string, data []byte) error {
return nil
}
+func (w *webhook) isEventFocused(event string) bool {
+ if w.focusEvents == nil || len(w.focusEvents) == 0 { | len(w.focusEvents) == 0 ε³ε― |
rinf | github_2023 | others | 349 | cunarist | temeddix | @@ -7,13 +7,18 @@ use super::interface_os::*;
#[cfg(target_family = "wasm")]
use super::interface_web::*;
+#[cfg(feature = "bevy")]
+use bevy_ecs::event::Event;
+
/// This is a mutable cell type that can be shared across threads.
pub type SharedCell<T> = OnceLock<Mutex<RefCell<Option<T>>>>;
/// This contains a message from Dart.
/// Optionally, a custom binary called `binary` can also be included.
/// This type is generic, and the message
/// can be of any type declared in Protobuf.
+/// If the bevy feature is used, every message can be received as an event in bevy. | A small request here, do you mind change the sentence to:
If the `bevy` feature is used, every message can be received as an event in Bevy. |
rinf | github_2023 | others | 349 | cunarist | temeddix | @@ -6,10 +6,14 @@ use super::interface_os::*;
#[cfg(target_family = "wasm")]
use super::interface_web::*;
+#[cfg(feature = "bevy")]
+use bevy_ecs::event::Event;
/// This contains a message from Dart.
/// Optionally, a custom binary called `binary` can also be included.
/// This type is generic, and the message
/// can be of any type declared in Protobuf.
+/// If the bevy feature is used, every message can be received as an event in Bevy.
+#[cfg_attr(feature = "bevy", derive(Event))] | Is it okay to write these as one line?
```
#[cfg_attr(feature = "bevy", derive(bevy_ecs::event::Event))]
``` |
rinf | github_2023 | others | 285 | cunarist | temeddix | @@ -1,17 +1,37 @@
+use clap::Parser;
+
+#[derive(Parser, Debug)]
+struct Args {
+ dart_args: Vec<String>,
+ #[arg(short, long)]
+ protoc_path: Option<String>,
+}
+
#[cfg(not(target_family = "wasm"))]
fn main() {
use std::env;
use std::fs;
use std::path;
+ use std::path::PathBuf;
use std::process;
+ use std::str::FromStr;
- // Install Protobuf compiler and get the path.
- let home_path = home::home_dir().unwrap();
- let out_path = home_path.join(".local").join("bin");
- fs::create_dir_all(&out_path).unwrap();
- env::set_var("OUT_DIR", out_path.to_str().unwrap());
- let (protoc_binary_path, _) = protoc_prebuilt::init("25.2").unwrap();
- let protoc_path = protoc_binary_path.parent().unwrap().to_path_buf();
+ let args = Args::parse();
+
+ let protoc_path;
+
+ if let Some(p) = args.protoc_path {
+ let provided = PathBuf::from_str(&p).unwrap(); | Yeah, I think it's a good idea to do it :) |
rinf | github_2023 | others | 267 | cunarist | temeddix | @@ -0,0 +1,120 @@
+import 'dart:io';
+
+import 'package:yaml/yaml.dart';
+
+class RinfConfigMessage {
+ final String inputDir;
+ final String rustOutputDir;
+ final String dartOutputDir;
+
+ RinfConfigMessage._({
+ required this.inputDir,
+ required this.rustOutputDir,
+ required this.dartOutputDir,
+ });
+
+ factory RinfConfigMessage.defaultConfig() {
+ return RinfConfigMessage._(
+ inputDir: DEFAULT_INPUT_DIR,
+ rustOutputDir: DEFAULT_RUST_OUTPUT_DIR,
+ dartOutputDir: DEFAULT_DART_OUTPUT_DIR,
+ );
+ }
+
+ factory RinfConfigMessage.from(YamlMap yaml) {
+ for (final key in yaml.keys) {
+ if (!MESSAGE_CONFIG_KEYS.contains(key)) {
+ throw Exception(
+ "Unknown key '$key' in rinf message configuration.\n"
+ "Available keys are: $MESSAGE_CONFIG_KEYS",
+ );
+ }
+ }
+ return RinfConfigMessage._(
+ inputDir: yaml[KEY_INPUT_DIR] ?? DEFAULT_INPUT_DIR,
+ rustOutputDir: yaml[KEY_RUST_OUTPUT_DIR] ?? DEFAULT_RUST_OUTPUT_DIR,
+ dartOutputDir: yaml[KEY_DART_OUTPUT_DIR] ?? DEFAULT_DART_OUTPUT_DIR,
+ );
+ }
+
+ @override
+ String toString() {
+ return '''message:
+ $KEY_INPUT_DIR: $inputDir
+ $KEY_RUST_OUTPUT_DIR: $rustOutputDir
+ $KEY_DART_OUTPUT_DIR: $dartOutputDir''';
+ }
+
+ static const KEY_INPUT_DIR = "input_dir";
+ static const KEY_RUST_OUTPUT_DIR = "rust_output_dir";
+ static const KEY_DART_OUTPUT_DIR = "dart_output_dir";
+
+ static const DEFAULT_INPUT_DIR = "messages";
+ static const DEFAULT_RUST_OUTPUT_DIR = "native/hub/src/messages";
+ static const DEFAULT_DART_OUTPUT_DIR = "lib/messages"; | My assumption is that we might need to add slash at the back or the front to make it align with all other code, but not sure right now. Maybe currently, the proto file can be generated like `lib/messagescounter_number.proto`. I should investigate more. |
rinf | github_2023 | cpp | 114 | cunarist | temeddix | @@ -31,6 +31,11 @@ bool FlutterWindow::OnCreate() {
this->Show();
});
+ // Flutter can complete the first frame before the "show window" callback is
+ // registered. The following call ensures a frame is pending to ensure the
+ // window is shown. It is a no-op if the first frame hasn't completed yet.
+ flutter_controller_->ForceRedraw(); | May I ask you where this line came from? Is it from new Flutter 3.13 default template or something? |
rinf | github_2023 | others | 99 | cunarist | temeddix | @@ -58,9 +58,10 @@ android {
}
}
+def target = new File(rootProject.projectDir.parent)
// Include Rust crates in the build process
-apply from: "../connectors/cargokit/gradle/plugin.gradle"
+apply from: "../cargokit/gradle/plugin.gradle"
cargokit {
- manifestDir = "${rootProject.projectDir}/../native/hub"
+ manifestDir = "../${target.name}/native/hub"
libname = "hub"
} | For this one, I'll test it with an actual Flutter project that I'm working on, which is inside totally different directory :) |
rinf | github_2023 | others | 99 | cunarist | temeddix | @@ -468,6 +468,18 @@ We appreciate your contribution to the development of this project!
[](https://github.com/cunarist/rust-in-flutter/graphs/contributors)
+# π Thanks
+
+These are tools for connecting Flutter and native compilers.
+
+Rust-In-Flutter was not made alone. There were pioneers that gave inspiration to the structure of this package. Credits to these wonderful efforts!
+
+- https://github.com/fzyzcjy/flutter_rust_bridge
+- https://github.com/superlistapp/super_native_extensions
+- https://github.com/brickpop/flutter-rust-ffi
+- https://github.com/corrosion-rs/corrosion
+- https://github.com/irondash/cargokit
+ | I personally think it would be better to move this to 'discussions' in Github in 'announcements' category. I will also handle this :) |
rinf | github_2023 | others | 91 | cunarist | temeddix | @@ -22,11 +22,11 @@ Designed for ease of use, future scalability, and unparalleled performance, this
All the challenging build settings are automatically handled by this package.
-| Platform \ Target | Android | iOS/iPadOS | Linux | macOS | Windows | Web |
-| ----------------- | ------- | ---------- | ----- | ----- | ------- | --- |
-| Linux | β
| - | β
| - | - | β
|
-| macOS | β
| β
| - | β
| - | β
|
-| Windows | β
| - | - | - | β
| β
|
+| Dev | Android | iOS | Linux | macOS | Windows | Web | | This means 'Dev platform', which points to linux/window/macos below. I made this change because I thought the column names should represent things 'below', not 'sideways'.
I will change the name to 'Dev OS' just to make it more clear. I wanted it to be shorter, too :) |
rinf | github_2023 | others | 91 | cunarist | temeddix | @@ -1,6 +1,11 @@
-[English Guide](https://github.com/cunarist/rust-in-flutter/blob/main/README.md) Β· [νκ΅μ΄ μ€λͺ
μ](https://github.com/cunarist/rust-in-flutter/blob/main/translations/KO.md) Β· [δΈζζζ‘£](https://github.com/cunarist/rust-in-flutter/blob/main/translations/ZH.md) Β· [ζ₯ζ¬θͺγ¬γ€γ](https://github.com/cunarist/rust-in-flutter/blob/main/translations/JA.md)
+[English Guide](https://github.com/cunarist/rust-in-flutter/blob/main/README.md) Β· [νκ΅μ΄ μ€λͺ
μ](./translations/KO.md) Β· [δΈζζζ‘£](./translations/ZH.md) Β· [ζ₯ζ¬θͺγ¬γ€γ](./translations/JA.md) | Using 'relative path' for translations will work well on GitHub, but might break the links on pub.dev, though I'm not 100% sure. Was this intentional?
<img width="519" alt="image" src="https://github.com/cunarist/rust-in-flutter/assets/66480156/1f472116-b15e-4208-aa51-5f55f2532b46">
|
rinf | github_2023 | others | 91 | cunarist | temeddix | @@ -38,6 +52,32 @@ jobs:
- name: Checkout submodules
run: git submodule update --init --recursive
+ # Automatic setup cache(Doesn't work )
+ # - name: Setup Nix
+ # if: matrix.runner == 'ubuntu-latest' || matrix.runner == 'macos-latest'
+ # uses: DeterminateSystems/nix-installer-action@main
+
+ # - name: Setup Magic Nix Cache
+ # if: matrix.runner == 'ubuntu-latest' || matrix.runner == 'macos-latest'
+ # uses: DeterminateSystems/magic-nix-cache-action@main
+
+ # - name: Run Nix Flake Check
+ # if: matrix.runner == 'ubuntu-latest' || matrix.runner == 'macos-latest'
+ # run: nix flake check | Also, are these comments intented? May I ask you the purpose? |
vite-rsc | github_2023 | typescript | 7 | cyco130 | cyco130 | @@ -20,7 +20,7 @@ export function removeRscQuery(id: string) {
.filter((part) => !part.match(/rsc($|=)/))
.join("&");
- if (newQuery) return base;
+ if (!newQuery) return base; | Definitely looks like one |
vite-rsc | github_2023 | others | 7 | cyco130 | cyco130 | @@ -8,6 +8,7 @@
],
"exports": {
"./entry-server": "./src/entry-server.ts",
+ "./streams": "./src/server/streams.tsx", | Sure, we just didn't organize well yet :) |
big-bear-casaos | github_2023 | others | 3,205 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,162 @@
+# Configuration for libredesk setup
+
+# Name of the big-bear-libredesk application
+name: big-bear-libredesk
+
+# Service definitions for the big-bear-libredesk application
+services:
+ # Service name: big-bear-libredesk
+ # The `big-bear-libredesk` service definition
+ big-bear-libredesk:
+ # Name of the container
+ container_name: big-bear-libredesk
+
+ # Image to be used for the container
+ image: libredesk/libredesk:v0.4.3-alpha
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables
+ environment:
+ - LIBREDESK_SYSTEM_USER_PASSWORD="casaos"
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local libredesk/uploads directory to /libredesk/uploads inside the container
+ - /DATA/AppData/$AppID/uploads:/libredesk/uploads:rw
+ # Mounting the local libredesk/config.toml directory to /libredesk/config.toml inside the container
+ - /DATA/AppData/$AppID/config:/libredesk/config:rw
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 9000 of the host to port 9000 of the container
+ - "9000:9000"
+
+ command:
+ [
+ sh,
+ -c,
+ "./libredesk --install --idempotent-install --yes --config /libredesk/config/config.toml && ./libredesk --upgrade --yes --config /libredesk/config/config.toml && ./libredesk --config /libredesk/config/config.toml",
+ ]
+
+ # Dependencies
+ depends_on:
+ - big-bear-libredesk-db
+ - big-bear-libredesk-redis
+
+ # Networks
+ networks:
+ - big-bear-libredesk-network
+
+ x-casaos: # CasaOS specific configuration
+ volumes:
+ - container: /libredesk/uploads
+ description:
+ en_us: "Container Path: /libredesk/uploads"
+ - container: /libredesk/config.toml
+ description:
+ en_us: "Container Path: /libredesk/config.toml"
+ ports: | _β οΈ Potential issue_
**CasaOS Specification Consistency for Service**
The CasaOS metadata provided for the `big-bear-libredesk` service is useful. However, there is a discrepancy:
- The volume mounts bind `/DATA/AppData/$AppID/config` to `/libredesk/config`, yet the CasaOS configuration specifies a container path of `/libredesk/config.toml`.
- The command expects the configuration file at `/libredesk/config/config.toml`.
It is important to align these paths. Please update the CasaOS configuration to reflect the correct container path (likely `/libredesk/config/config.toml`).
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 3,133 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,63 @@
+name: big-bear-jlesage-handbrake # Name of the CasaOS application
+
+services:
+ big-bear-jlesage-handbrake:
+ container_name: big-bear-jlesage-handbrake # Name of the Docker container
+ image: jlesage/handbrake:v25.02.3 # Docker image for the Handbrake
+ ports:
+ - "5800:5800" # Expose port 5800 for VNC access
+ environment:
+ - VNC_PASSWORD=casaos # Set the VNC password to 'casaos'
+ volumes:
+ - /DATA/AppData/$AppID/config:/config:rw
+ - /DATA/AppData/$AppID/storage:/storage:ro
+ - /DATA/AppData/$AppID/watch:/watch:rw
+ - /DATA/AppData/$AppID/output:/output:rw
+
+ x-casaos: # CasaOS specific configuration for the brave service
+ envs:
+ - container: VNC_PASSWORD
+ description:
+ en_us: VNC Password # Description for the VNC password environment variable
+ ports:
+ - container: "5800"
+ description:
+ en_us: "Container Port: 5800"
+ volumes:
+ - container: /config
+ description:
+ en_us: "Container Path: /config"
+ - container: /storage
+ description:
+ en_us: "Container Path: /storage"
+ - container: /watch
+ description:
+ en_us: "Container Path: /watch"
+ - container: /output
+ description:
+ en_us: "Container Path: /output"
+ | _π οΈ Refactor suggestion_
**CasaOS-Specific Configuration Comment Accuracy.**
The CasaOS-specific configuration block is comprehensive, detailing environment variables, port mappings, and volume descriptions. However, the comment on line 17 states βCasaOS specific configuration for the brave serviceβ which seems to be a copy-paste artifact. Updating this comment to reflect the Handbrake service will avoid confusion.
```diff
- x-casaos: # CasaOS specific configuration for the brave service
+ x-casaos: # CasaOS specific configuration for the Handbrake service
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
x-casaos: # CasaOS specific configuration for the Handbrake service
envs:
- container: VNC_PASSWORD
description:
en_us: VNC Password # Description for the VNC password environment variable
ports:
- container: "5800"
description:
en_us: "Container Port: 5800"
volumes:
- container: /config
description:
en_us: "Container Path: /config"
- container: /storage
description:
en_us: "Container Path: /storage"
- container: /watch
description:
en_us: "Container Path: /watch"
- container: /output
description:
en_us: "Container Path: /output"
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 3,099 | bigbeartechworld | coderabbitai[bot] | @@ -102,13 +106,14 @@ services:
big-bear-owncloud-db:
container_name: big-bear-owncloud-db
- image: mariadb:10.6 # minimum required ownCloud version is 10.9
+ image: mariadb:10.6
restart: unless-stopped
environment:
- MYSQL_ROOT_PASSWORD=f01914eb-2be3-4164-a57c-08e6518f313a
- MYSQL_USER=bigbear
- MYSQL_PASSWORD=f01914eb-2be3-4164-a57c-08e6518f313a | _β οΈ Potential issue_
**Sensitive Credentials in Environment Variables**
Static analysis detected hardcoded credentials for MySQL (e.g., `MYSQL_ROOT_PASSWORD` and `MYSQL_PASSWORD`) in the environment variables. Hardcoding such sensitive information can lead to security vulnerabilities. Consider using Docker secrets or other secure methods to inject these credentials at runtime.
[security]
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ Gitleaks (8.21.2)</summary>
112-112: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
---
114-114: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 3,099 | bigbeartechworld | coderabbitai[bot] | @@ -117,14 +122,14 @@ services:
"mysqladmin",
"ping",
"-u",
- "root",
+ "bigbear",
"--password=f01914eb-2be3-4164-a57c-08e6518f313a", | _β οΈ Potential issue_
**Hardcoded Password in Healthcheck Command**
The healthcheck command includes a hardcoded password (`--password=f01914eb-2be3-4164-a57c-08e6518f313a`), which can expose sensitive information. It is recommended to use a more secure mechanism (such as environment variable substitution or Docker secrets) to manage this credential.
[security]
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ Gitleaks (8.21.2)</summary>
126-126: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE | _:warning: Potential issue_
**Critical: Replace hardcoded credentials with secure alternatives**
Several security concerns need to be addressed:
1. The `SECRET_KEY_BASE` is set to a literal string "SECRET_KEY_BASE" which is insecure
2. Database password is hardcoded in the compose file
Consider using environment variables or Docker secrets:
```diff
- SECRET_KEY_BASE: SECRET_KEY_BASE
+ SECRET_KEY_BASE: ${SECRET_KEY_BASE}
- POSTGRES_PASSWORD: casaos
+ POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
```
Also applies to: 65-65
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres:
+ # Name of the container
+ container_name: postgres
+
+ # Image to be used for the container
+ image: postgres:16
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
+ - /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+
+ # Environment variables
+ environment:
+ # Name of the database to create
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # Health check configuration for the PostgreSQL service
+ healthcheck:
+ # Command to check if PostgreSQL is ready
+ test: [ "CMD-SHELL", "pg_isready -U maybe_user -d maybe_production" ]
+
+ # Interval between health checks
+ interval: 5s
+
+ # Timeout for the health check command
+ timeout: 5s
+
+ # Number of retries before considering the service unhealthy
+ retries: 5
+
+ # Network configuration for the PostgreSQL service
+ networks:
+ # Use the default Docker network
+ - default
+ | _:hammer_and_wrench: Refactor suggestion_
**Enhance PostgreSQL service security and reliability**
Several improvements are recommended for the database service:
1. The database credentials are hardcoded (already mentioned above)
2. No resource limits are set
3. No backup volume is configured
4. Database is accessible from the default network
Apply these improvements:
```diff
postgres:
container_name: postgres
image: postgres:16
+ deploy:
+ resources:
+ limits:
+ memory: 1G
+ cpus: '1'
+ reservations:
+ memory: 256M
+ cpus: '0.25'
volumes:
- /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+ - /DATA/AppData/$AppID/postgres-backup:/backup
+ command: >
+ -c max_connections=100
+ -c shared_buffers=256MB
environment:
- POSTGRES_DB: maybe_production
- POSTGRES_USER: maybe_user
- POSTGRES_PASSWORD: casaos
+ POSTGRES_DB: ${POSTGRES_DB:-maybe_production}
+ POSTGRES_USER: ${POSTGRES_USER:-maybe_user}
+ POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
postgres:
# Name of the container
container_name: postgres
# Image to be used for the container
image: postgres:16
# Resource limits and reservations
deploy:
resources:
limits:
memory: 1G
cpus: '1'
reservations:
memory: 256M
cpus: '0.25'
# Container restart policy
restart: unless-stopped
# Volumes to be mounted to the container
volumes:
# Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
- /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
- /DATA/AppData/$AppID/postgres-backup:/backup
# PostgreSQL configuration
command: >
-c max_connections=100
-c shared_buffers=256MB
# Environment variables
environment:
# Name of the database to create
POSTGRES_DB: ${POSTGRES_DB:-maybe_production}
# PostgreSQL user
POSTGRES_USER: ${POSTGRES_USER:-maybe_user}
# Password for the PostgreSQL user
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
# Health check configuration for the PostgreSQL service
healthcheck:
# Command to check if PostgreSQL is ready
test: [ "CMD-SHELL", "pg_isready -U maybe_user -d maybe_production" ]
# Interval between health checks
interval: 5s
# Timeout for the health check command
timeout: 5s
# Number of retries before considering the service unhealthy
retries: 5
# Network configuration for the PostgreSQL service
networks:
# Use the default Docker network
- default
`````
</details>
<!-- suggestion_end -->
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ yamllint</summary>
[error] 177-177: trailing spaces
(trailing-spaces)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+ | _:hammer_and_wrench: Refactor suggestion_
**Add resource constraints to prevent container abuse**
The app service lacks memory and CPU limits, which could lead to resource exhaustion.
Add resource limits:
```diff
app:
container_name: big-bear-maybe-finance
+ deploy:
+ resources:
+ limits:
+ memory: 2G
+ cpus: '2'
+ reservations:
+ memory: 512M
+ cpus: '0.5'
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
app:
# Name of the container
container_name: big-bear-maybe-finance
# Image to be used for the container
image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
# Container restart policy
restart: unless-stopped
# Privilege of the container
privileged: false
deploy:
resources:
limits:
memory: 2G
cpus: '2'
reservations:
memory: 512M
cpus: '0.5'
# Uses default network mode
networks:
# Use the default Docker network
- default
# Volumes to be mounted to the container
volumes:
# Mounting the local maybe/pp-storage directory to /rails/storage inside the container
- /DATA/AppData/$AppID/app-storage:/rails/storage
# Ports mapping between host and container
ports:
# Mapping port 3000 of the host to port 3000 of the container
- 3000:3000
# Environment variables
environment:
# Indicates the application is self-hosted
SELF_HOSTED: "true"
# SSL configuration
RAILS_FORCE_SSL: "false"
# SSL assumption configuration
RAILS_ASSUME_SSL: "false"
# Sets the execution mode for GoodJob
GOOD_JOB_EXECUTION_MODE: async
# Secret key for Rails application
SECRET_KEY_BASE: SECRET_KEY_BASE
# Hostname for the PostgreSQL database service
DB_HOST: postgres
# Name of the PostgreSQL database
POSTGRES_DB: maybe_production
# PostgreSQL user
POSTGRES_USER: maybe_user
# Password for the PostgreSQL user
POSTGRES_PASSWORD: casaos
# This section specifies that the `app` service depends on another service named `postgres`.
depends_on:
postgres:
# Ensures that the `app` service starts only after `postgres` is healthy
condition: service_healthy
`````
</details>
<!-- suggestion_end -->
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ yamllint</summary>
[error] 27-27: trailing spaces
(trailing-spaces)
---
[error] 37-37: trailing spaces
(trailing-spaces)
---
[error] 54-54: trailing spaces
(trailing-spaces)
---
[error] 66-66: trailing spaces
(trailing-spaces)
---
[error] 72-72: trailing spaces
(trailing-spaces)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app: | Change app to: `big-bear-maybe-finance` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos | For database password's I've been generating UUID V4. |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup | Change the peppermint to maybe-finance |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application | Change the big-bear-peppermint to big-bear-maybe-finance |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default | Change default to `big_bear_maybe_finance_network` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres: | Change to `big-bear-maybe-finance-postgres` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres: | Change to `big-bear-maybe-finance-postgres` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres:
+ # Name of the container
+ container_name: postgres | Change to `big-bear-maybe-finance-postgres` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres:
+ # Name of the container
+ container_name: postgres
+
+ # Image to be used for the container
+ image: postgres:16
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
+ - /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+
+ # Environment variables
+ environment:
+ # Name of the database to create
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # Health check configuration for the PostgreSQL service
+ healthcheck:
+ # Command to check if PostgreSQL is ready
+ test: [ "CMD-SHELL", "pg_isready -U maybe_user -d maybe_production" ]
+
+ # Interval between health checks
+ interval: 5s
+
+ # Timeout for the health check command
+ timeout: 5s
+
+ # Number of retries before considering the service unhealthy
+ retries: 5
+
+ # Network configuration for the PostgreSQL service
+ networks:
+ # Use the default Docker network
+ - default | Change default to `big_bear_maybe_finance_network` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres:
+ # Name of the container
+ container_name: postgres
+
+ # Image to be used for the container
+ image: postgres:16
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
+ - /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+
+ # Environment variables
+ environment:
+ # Name of the database to create
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # Health check configuration for the PostgreSQL service
+ healthcheck:
+ # Command to check if PostgreSQL is ready
+ test: [ "CMD-SHELL", "pg_isready -U maybe_user -d maybe_production" ]
+
+ # Interval between health checks
+ interval: 5s
+
+ # Timeout for the health check command
+ timeout: 5s
+
+ # Number of retries before considering the service unhealthy
+ retries: 5
+
+ # Network configuration for the PostgreSQL service
+ networks:
+ # Use the default Docker network
+ - default
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /var/lib/postgresql/data
+ description:
+ en_us: "Container Path: /var/lib/postgresql/data"
+ envs:
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+# Definition of networks used in the services
+networks:
+ default:
+ # Custom name for the default network
+ name: maybe_network | Change default to `big_bear_maybe_finance_network` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres:
+ # Name of the container
+ container_name: postgres
+
+ # Image to be used for the container
+ image: postgres:16
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
+ - /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+
+ # Environment variables
+ environment:
+ # Name of the database to create
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # Health check configuration for the PostgreSQL service
+ healthcheck:
+ # Command to check if PostgreSQL is ready
+ test: [ "CMD-SHELL", "pg_isready -U maybe_user -d maybe_production" ]
+
+ # Interval between health checks
+ interval: 5s
+
+ # Timeout for the health check command
+ timeout: 5s
+
+ # Number of retries before considering the service unhealthy
+ retries: 5
+
+ # Network configuration for the PostgreSQL service
+ networks:
+ # Use the default Docker network
+ - default
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /var/lib/postgresql/data
+ description:
+ en_us: "Container Path: /var/lib/postgresql/data"
+ envs:
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+# Definition of networks used in the services
+networks:
+ default:
+ # Custom name for the default network
+ name: maybe_network
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ # - arm64
+
+ # Main service of the application
+ main: app | Change to `big-bear-maybe-finance` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-peppermint application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-peppermint application
+services:
+ # Service name: app
+ # The `app` service definition
+ app:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - default
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: postgres
+ # The `postgres` service definition
+ postgres:
+ # Name of the container
+ container_name: postgres
+
+ # Image to be used for the container
+ image: postgres:16
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
+ - /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+
+ # Environment variables
+ environment:
+ # Name of the database to create
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos | Change to the generated UUID V4 that you generated in the `big-bear-maybe-finance` service. |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,8 @@
+{
+ "id": "MaybeFinance",
+ "version": "0.1.0", | Change to: `sha-9522a191de1f258d76ed996ba1c84e3a0629dd80` or BigBearCI will not pass. |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | dragonfire1119 | @@ -201,7 +201,7 @@ services:
# Definition of networks used in the services
networks:
- default:
+ big_bear_maybe_finance_network:
# Custom name for the default network
name: maybe_network | Change name to: `big_bear_maybe_finance_network` |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-maybe-finance application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-maybe-finance application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-maybe-finance:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - big_bear_maybe_finance_network
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ big-bear-maybe-finance-postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /rails/storage
+ description:
+ en_us: "Container Path: /rails/storage"
+
+ # Port definitions for the application
+ ports:
+ # Port exposed by the application
+ - container: "3000"
+ description:
+ en_us: "Container Port: 3000"
+
+ # Environment variable definitions for the application
+ envs:
+ # Indicates if the application is self-hosted
+ - container: SELF_HOSTED
+ description:
+ en_us: "Indicates whether the application is self-hosted (true/false)."
+
+ # Configuration for SSL enforcement
+ - container: RAILS_FORCE_SSL
+ description:
+ en_us: "Determines if SSL should be forced (true/false)."
+
+ # Execution mode for GoodJob background processing
+ - container: GOOD_JOB_EXECUTION_MODE
+ description:
+ en_us: "Sets the execution mode for GoodJob (e.g., async)."
+
+ # Security key for the Rails application
+ - container: SECRET_KEY_BASE
+ description:
+ en_us: "Secret key used for verifying the integrity of signed cookies."
+
+ # Hostname of the PostgreSQL database
+ - container: DB_HOST
+ description:
+ en_us: "Hostname for the PostgreSQL database service."
+
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+ # Service name: big-bear-maybe-finance-postgres
+ # The `postgres` service definition
+ big-bear-maybe-finance-postgres:
+ # Name of the container
+ container_name: big-bear-maybe-finance-postgres
+
+ # Image to be used for the container
+ image: postgres:16
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/postgres-data directory to /var/lib/postgresql/data inside the container
+ - /DATA/AppData/$AppID/postgres-data:/var/lib/postgresql/data
+
+ # Environment variables
+ environment:
+ # Name of the database to create
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # Health check configuration for the PostgreSQL service
+ healthcheck:
+ # Command to check if PostgreSQL is ready
+ test: [ "CMD-SHELL", "pg_isready -U maybe_user -d maybe_production" ]
+
+ # Interval between health checks
+ interval: 5s
+
+ # Timeout for the health check command
+ timeout: 5s
+
+ # Number of retries before considering the service unhealthy
+ retries: 5
+
+ # Network configuration for the PostgreSQL service
+ networks:
+ # Use the default Docker network
+ - big_bear_maybe_finance_network
+
+ # CasaOS specific configuration
+ x-casaos:
+ # Volume definitions for the application
+ volumes:
+ # Path in the container for application storage
+ - container: /var/lib/postgresql/data
+ description:
+ en_us: "Container Path: /var/lib/postgresql/data"
+ envs:
+ # Name of the PostgreSQL database
+ - container: POSTGRES_DB
+ description:
+ en_us: "PostgreSQL database to be created and used by the application."
+
+ # PostgreSQL username
+ - container: POSTGRES_USER
+ description:
+ en_us: "Username for connecting to the PostgreSQL database."
+
+ # Password for the PostgreSQL user
+ - container: POSTGRES_PASSWORD
+ description:
+ en_us: "Password for the PostgreSQL user."
+
+# Definition of networks used in the services
+networks:
+ big_bear_maybe_finance_network:
+ # Custom name for the default network
+ name: maybe_network | _:warning: Potential issue_
**Fix network name inconsistency**
The network name doesn't match its usage in the services:
- Defined as: `maybe_network`
- Used as: `big_bear_maybe_finance_network`
```diff
networks:
big_bear_maybe_finance_network:
- name: maybe_network
+ name: big_bear_maybe_finance_network
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
networks:
big_bear_maybe_finance_network:
# Custom name for the default network
name: big_bear_maybe_finance_network
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-maybe-finance application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-maybe-finance application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-maybe-finance:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - big_bear_maybe_finance_network
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos
+
+ # This section specifies that the `app` service depends on another service named `postgres`.
+ depends_on:
+ big-bear-maybe-finance-postgres:
+ # Ensures that the `app` service starts only after `postgres` is healthy
+ condition: service_healthy
+ | _:hammer_and_wrench: Refactor suggestion_
**Add health check and resource constraints to the application service**
The service configuration should include:
1. Health check to ensure the application is ready
2. Resource limits to prevent container resource exhaustion
```diff
big-bear-maybe-finance:
container_name: big-bear-maybe-finance
image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
restart: unless-stopped
+ healthcheck:
+ test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
+ interval: 30s
+ timeout: 10s
+ retries: 3
+ deploy:
+ resources:
+ limits:
+ memory: 2G
+ cpus: '2'
+ reservations:
+ memory: 512M
+ cpus: '0.5'
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
big-bear-maybe-finance:
# Name of the container
container_name: big-bear-maybe-finance
# Image to be used for the container
image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
# Container restart policy
restart: unless-stopped
# Privilege of the container
privileged: false
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
interval: 30s
timeout: 10s
retries: 3
deploy:
resources:
limits:
memory: 2G
cpus: '2'
reservations:
memory: 512M
cpus: '0.5'
# Uses default network mode
networks:
# Use the default Docker network
- big_bear_maybe_finance_network
# Volumes to be mounted to the container
volumes:
# Mounting the local maybe/pp-storage directory to /rails/storage inside the container
- /DATA/AppData/$AppID/app-storage:/rails/storage
# Ports mapping between host and container
ports:
# Mapping port 3000 of the host to port 3000 of the container
- 3000:3000
# Environment variables
environment:
# Indicates the application is self-hosted
SELF_HOSTED: "true"
# SSL configuration
RAILS_FORCE_SSL: "false"
# SSL assumption configuration
RAILS_ASSUME_SSL: "false"
# Sets the execution mode for GoodJob
GOOD_JOB_EXECUTION_MODE: async
# Secret key for Rails application
SECRET_KEY_BASE: SECRET_KEY_BASE
# Hostname for the PostgreSQL database service
DB_HOST: postgres
# Name of the PostgreSQL database
POSTGRES_DB: maybe_production
# PostgreSQL user
POSTGRES_USER: maybe_user
# Password for the PostgreSQL user
POSTGRES_PASSWORD: casaos
# This section specifies that the `app` service depends on another service named `postgres`.
depends_on:
big-bear-maybe-finance-postgres:
# Ensures that the `app` service starts only after `postgres` is healthy
condition: service_healthy
`````
</details>
<!-- suggestion_end -->
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ yamllint</summary>
[error] 27-27: trailing spaces
(trailing-spaces)
---
[error] 37-37: trailing spaces
(trailing-spaces)
---
[error] 54-54: trailing spaces
(trailing-spaces)
---
[error] 66-66: trailing spaces
(trailing-spaces)
---
[error] 72-72: trailing spaces
(trailing-spaces)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-maybe-finance application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-maybe-finance application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-maybe-finance:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+ | _:hammer_and_wrench: Refactor suggestion_
**Add health check and resource constraints**
The service should include:
1. Health check to ensure the application is ready
2. Resource limits to prevent container resource exhaustion
```diff
big-bear-maybe-finance:
container_name: big-bear-maybe-finance
image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
restart: unless-stopped
+ healthcheck:
+ test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
+ interval: 30s
+ timeout: 10s
+ retries: 3
+ deploy:
+ resources:
+ limits:
+ memory: 2G
+ cpus: '2'
+ reservations:
+ memory: 512M
+ cpus: '0.5'
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
big-bear-maybe-finance:
# Name of the container
container_name: big-bear-maybe-finance
# Image to be used for the container
image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
# Container restart policy
restart: unless-stopped
# Privilege of the container
privileged: false
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
interval: 30s
timeout: 10s
retries: 3
deploy:
resources:
limits:
memory: 2G
cpus: '2'
reservations:
memory: 512M
cpus: '0.5'
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,021 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,274 @@
+# Configuration for peppermint setup
+
+# Name of the big-bear-maybe-finance application
+name: big-bear-maybe-finance
+
+# Service definitions for the big-bear-maybe-finance application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-maybe-finance:
+ # Name of the container
+ container_name: big-bear-maybe-finance
+
+ # Image to be used for the container
+ image: ghcr.io/maybe-finance/maybe:sha-9522a191de1f258d76ed996ba1c84e3a0629dd80
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Privilege of the container
+ privileged: false
+
+ # Uses default network mode
+ networks:
+ # Use the default Docker network
+ - big_bear_maybe_finance_network
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local maybe/pp-storage directory to /rails/storage inside the container
+ - /DATA/AppData/$AppID/app-storage:/rails/storage
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - 3000:3000
+
+ # Environment variables
+ environment:
+ # Indicates the application is self-hosted
+ SELF_HOSTED: "true"
+
+ # SSL configuration
+ RAILS_FORCE_SSL: "false"
+
+ # SSL assumption configuration
+ RAILS_ASSUME_SSL: "false"
+
+ # Sets the execution mode for GoodJob
+ GOOD_JOB_EXECUTION_MODE: async
+
+ # Secret key for Rails application
+ SECRET_KEY_BASE: SECRET_KEY_BASE
+
+ # Hostname for the PostgreSQL database service
+ DB_HOST: postgres
+
+ # Name of the PostgreSQL database
+ POSTGRES_DB: maybe_production
+
+ # PostgreSQL user
+ POSTGRES_USER: maybe_user
+
+ # Password for the PostgreSQL user
+ POSTGRES_PASSWORD: casaos | _:warning: Potential issue_
**Critical: Replace hardcoded credentials with environment variables**
The credentials are still hardcoded in the compose file, which is a security risk. This includes:
- `SECRET_KEY_BASE` set to literal "SECRET_KEY_BASE"
- Database credentials hardcoded
```diff
- SECRET_KEY_BASE: SECRET_KEY_BASE
+ SECRET_KEY_BASE: ${SECRET_KEY_BASE}
- POSTGRES_PASSWORD: casaos
+ POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
```
Note: The tips section already includes instructions for generating a secure `SECRET_KEY_BASE`. Consider adding similar instructions for generating a secure database password.
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
SECRET_KEY_BASE: ${SECRET_KEY_BASE}
# Hostname for the PostgreSQL database service
DB_HOST: postgres
# Name of the PostgreSQL database
POSTGRES_DB: maybe_production
# PostgreSQL user
POSTGRES_USER: maybe_user
# Password for the PostgreSQL user
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
`````
</details>
<!-- suggestion_end -->
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ yamllint</summary>
[error] 54-54: trailing spaces
(trailing-spaces)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 1,634 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,90 @@
+# Configuration for Jenkins setup
+
+# Name of the big-bear-jenkins application
+name: big-bear-jenkins
+
+# Service definitions for the big-bear-jenkins application
+services:
+ # Service name: big-bear-jenkins
+ # The `big-bear-jenkins` service definition
+ big-bear-jenkins:
+ # Name of the container
+ container_name: big-bear-jenkins
+
+ # Image to be used for the container
+ image: jenkins/jenkins:lts-jdk17
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables for the container
+ environment:
+ - PUID=1000
+ - PGID=1000
+ - TZ=Etc/UTC
+
+ # Ports mapping between host and container
+ ports:
+ - 8080:8080
+ - 50000:50000
+
+ # Volumes mapping between host and container
+ volumes:
+ - jenkins_home:/var/jenkins_home
+
+ security_opt:
+ - seccomp:unconfined #optional
+
+ shm_size: "1gb" #optional
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: PUID
+ description:
+ en_us: Process UID
+ - container: PGID
+ description:
+ en_us: Process GID
+ - container: TZ
+ description:
+ en_us: Timezone
+ ports:
+ - container: "8080"
+ description:
+ en_us: "Jenkins Web Interface"
+ - container: "50000"
+ description:
+ en_us: "Jenkins Agent Port"
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: big-bear-jenkins
+ description:
+ # Description in English
+ en_us: Jenkins is a self-contained, open source automation server which can be used to automate all sorts of tasks related to building, testing, and delivering or deploying software.
+ tagline:
+ # Short description or tagline in English
+ en_us: Jenkins
+ # Developer's name or identifier
+ developer: "Jenkins"
+ # Author of this configuration
+ author: bepp-boop
+ # Icon for the application
+ icon: https://cdn.jsdelivr.net/gh/bigbeartechworld/big-bear-casaos/Apps/jenkins/logo.png
+ # Thumbnail image (currently empty)
+ thumbnail: ""
+ title:
+ # Title in English
+ en_us: Jenkins
+ # Application category
+ category: BigBearCasaOS
+ # Port mapping information
+ port_map: "8080" | _:bulb: Codebase verification_
**Thumbnail Image Missing**
The thumbnail image specified in the configuration does not exist at the provided URL. Please add a valid thumbnail image to enhance the app's visual representation in the CasaOS interface.
Additionally, consider the following suggestions:
- **Category:** Ensure that the category "BigBearCasaOS" is a standard category in CasaOS. If not, use a more general category like "Development" or "Continuous Integration".
- **Port Mapping:** Consider including port `50000` in the `port_map` field, as it is used for Jenkins agents.
<details>
<summary>π Analysis chain</summary>
**Review and enhance CasaOS-specific configuration**
The CasaOS-specific configuration is well-structured and provides essential information. However, there are a few points to consider:
1. Thumbnail: The thumbnail field is empty. Consider adding a thumbnail image URL to improve the visual representation of the app in the CasaOS interface.
2. Category: The category "BigBearCasaOS" might not be a standard category in CasaOS. Consider using a more general category like "Development" or "Continuous Integration".
3. Port mapping: Only port 8080 is mentioned in the port_map field. Consider including port 50000 as well, as it's used for Jenkins agents.
Consider applying these changes:
```diff
- thumbnail: ""
+ thumbnail: "https://cdn.jsdelivr.net/gh/bigbeartechworld/big-bear-casaos/Apps/jenkins/thumbnail.png"
- category: BigBearCasaOS
+ category: Development
- port_map: "8080"
+ port_map: "8080,50000"
```
Let's verify if the thumbnail image exists:
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Check if the thumbnail image exists
curl -I https://cdn.jsdelivr.net/gh/bigbeartechworld/big-bear-casaos/Apps/jenkins/thumbnail.png
```
Length of output: 1303
---
Script:
```shell
#!/bin/bash
# Check if the thumbnail image exists
curl -I https://cdn.jsdelivr.net/gh/bigbeartechworld/big-bear-casaos/Apps/jenkins/thumbnail.png
```
Length of output: 1149
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 1,634 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,90 @@
+# Configuration for Jenkins setup
+
+# Name of the big-bear-jenkins application
+name: big-bear-jenkins
+
+# Service definitions for the big-bear-jenkins application
+services:
+ # Service name: big-bear-jenkins
+ # The `big-bear-jenkins` service definition
+ big-bear-jenkins:
+ # Name of the container
+ container_name: big-bear-jenkins
+
+ # Image to be used for the container
+ image: jenkins/jenkins:lts-jdk17
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables for the container
+ environment:
+ - PUID=1000
+ - PGID=1000
+ - TZ=Etc/UTC
+
+ # Ports mapping between host and container
+ ports:
+ - 8080:8080
+ - 50000:50000
+
+ # Volumes mapping between host and container
+ volumes:
+ - jenkins_home:/var/jenkins_home
+
+ security_opt:
+ - seccomp:unconfined #optional
+
+ shm_size: "1gb" #optional | _:bulb: Codebase verification_
_:hammer_and_wrench: Refactor suggestion_
**Make Environment Variables Configurable and Address Potential Syntax Issues**
The environment variables `PUID`, `PGID`, and `TZ` in `Apps/jenkins/docker-compose.yml` are currently set to fixed values. To enhance flexibility and adaptability across different environments, consider making these variables configurable. Additionally, the script output suggests potential syntax issues that should be addressed.
1. **Environment Variables:**
- **Current Configuration:**
```yaml
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
```
- **Suggested Configuration:**
```diff
environment:
- - PUID=1000
- - PGID=1000
- - TZ=Etc/UTC
+ - PUID=${PUID:-1000}
+ - PGID=${PGID:-1000}
+ - TZ=${TZ:-Etc/UTC}
```
This change allows overriding the default values by setting environment variables externally.
2. **Potential Syntax Issues:**
- The script output included lines like `container: PUID`, which are not standard in Docker Compose configurations. Review the `docker-compose.yml` file to ensure all configurations are correctly specified.
<details>
<summary>π Analysis chain</summary>
**Review service configuration and consider potential improvements**
The service configuration looks good overall, but there are a few points to consider:
1. Environment variables:
- The PUID and PGID are set to 1000. These might not be appropriate for all systems. Consider using `${PUID:-1000}` and `${PGID:-1000}` to allow overriding these values.
- The timezone is set to UTC. While this is a good default, you might want to make it configurable.
2. Security:
- The `seccomp:unconfined` option (line 36) disables an important security feature. This should only be used if absolutely necessary. Consider removing this option or documenting why it's needed.
3. Resources:
- The shared memory size of 1GB (line 38) might be excessive for some systems. Consider making this configurable or reducing it if not necessary.
Consider applying these changes:
```diff
environment:
- - PUID=1000
- - PGID=1000
- - TZ=Etc/UTC
+ - PUID=${PUID:-1000}
+ - PGID=${PGID:-1000}
+ - TZ=${TZ:-Etc/UTC}
-security_opt:
- - seccomp:unconfined #optional
-shm_size: "1gb" #optional
+shm_size: "${JENKINS_SHM_SIZE:-256m}" #optional
```
To ensure these environment variables are properly documented, let's check the CasaOS configuration:
---
**Failed to retrieve environment variable documentation**
The script encountered an error and did not produce the expected output. Please run the following script to verify that `PUID`, `PGID`, and `TZ` are properly documented in the `docker-compose.yml` file.
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Check if PUID, PGID, and TZ are properly documented in CasaOS configuration
grep -A 3 "PUID\|PGID\|TZ" Apps/jenkins/docker-compose.yml
```
Length of output: 1304
---
Script:
```shell
#!/bin/bash
# Verify PUID, PGID, and TZ environment variables in docker-compose.yml
grep -E "PUID|PGID|TZ" Apps/jenkins/docker-compose.yml
```
Length of output: 187
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 1,634 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,90 @@
+# Configuration for Jenkins setup
+
+# Name of the big-bear-jenkins application
+name: big-bear-jenkins
+
+# Service definitions for the big-bear-jenkins application
+services:
+ # Service name: big-bear-jenkins
+ # The `big-bear-jenkins` service definition
+ big-bear-jenkins:
+ # Name of the container
+ container_name: big-bear-jenkins
+
+ # Image to be used for the container
+ image: jenkins/jenkins:lts-jdk17
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables for the container
+ environment:
+ - PUID=1000
+ - PGID=1000
+ - TZ=Etc/UTC
+
+ # Ports mapping between host and container
+ ports:
+ - 8080:8080
+ - 50000:50000
+
+ # Volumes mapping between host and container
+ volumes:
+ - jenkins_home:/var/jenkins_home | This needs to be `/DATA/AppData/$AppID/jenkins_home` |
big-bear-casaos | github_2023 | others | 1,634 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,90 @@
+# Configuration for Jenkins setup
+
+# Name of the big-bear-jenkins application
+name: big-bear-jenkins
+
+# Service definitions for the big-bear-jenkins application
+services:
+ # Service name: big-bear-jenkins
+ # The `big-bear-jenkins` service definition
+ big-bear-jenkins:
+ # Name of the container
+ container_name: big-bear-jenkins
+
+ # Image to be used for the container
+ image: jenkins/jenkins:lts-jdk17
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables for the container
+ environment:
+ - PUID=1000
+ - PGID=1000
+ - TZ=Etc/UTC
+
+ # Ports mapping between host and container
+ ports:
+ - 8080:8080
+ - 50000:50000
+
+ # Volumes mapping between host and container
+ volumes:
+ - jenkins_home:/var/jenkins_home
+
+ security_opt:
+ - seccomp:unconfined #optional
+
+ shm_size: "1gb" #optional
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: PUID
+ description:
+ en_us: Process UID
+ - container: PGID
+ description:
+ en_us: Process GID
+ - container: TZ
+ description:
+ en_us: Timezone
+ ports:
+ - container: "8080"
+ description:
+ en_us: "Jenkins Web Interface"
+ - container: "50000"
+ description:
+ en_us: "Jenkins Agent Port"
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: big-bear-jenkins
+ description:
+ # Description in English
+ en_us: Jenkins is a self-contained, open source automation server which can be used to automate all sorts of tasks related to building, testing, and delivering or deploying software.
+ tagline:
+ # Short description or tagline in English
+ en_us: Jenkins
+ # Developer's name or identifier
+ developer: "Jenkins"
+ # Author of this configuration
+ author: bepp-boop
+ # Icon for the application
+ icon: https://cdn.jsdelivr.net/gh/bigbeartechworld/big-bear-casaos/Apps/jenkins/logo.png
+ # Thumbnail image (currently empty)
+ thumbnail: ""
+ title:
+ # Title in English
+ en_us: Jenkins
+ # Application category
+ category: BigBearCasaOS
+ # Port mapping information
+ port_map: "8080"
+
+volumes: | Remove the volumes. CasaOS doesn't support it. |
big-bear-casaos | github_2023 | others | 2,802 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,118 @@
+# Configuration for otel-lgtm setup
+
+# Name of the otel-lgtm application
+name: otel-lgtm | This needs to be `big-bear-otel-lgtm` |
big-bear-casaos | github_2023 | others | 2,802 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,118 @@
+# Configuration for otel-lgtm setup
+
+# Name of the otel-lgtm application
+name: otel-lgtm
+
+# Service definitions for otel-lgtm application
+services:
+ # Service name: otel-lgtm
+ # The `otel-lgtm` service definition
+ otel-lgtm: | This needs to be `big-bear-otel-lgtm` |
big-bear-casaos | github_2023 | others | 2,802 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,118 @@
+# Configuration for otel-lgtm setup
+
+# Name of the otel-lgtm application
+name: otel-lgtm
+
+# Service definitions for otel-lgtm application
+services:
+ # Service name: otel-lgtm
+ # The `otel-lgtm` service definition
+ otel-lgtm:
+ # Name of the container
+ container_name: otel-lgtm | This needs to be `big-bear-otel-lgtm` |
big-bear-casaos | github_2023 | others | 2,802 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,118 @@
+# Configuration for otel-lgtm setup
+
+# Name of the otel-lgtm application
+name: otel-lgtm
+
+# Service definitions for otel-lgtm application
+services:
+ # Service name: otel-lgtm
+ # The `otel-lgtm` service definition
+ otel-lgtm:
+ # Name of the container
+ container_name: otel-lgtm
+
+ # Image to be used for the container
+ image: grafana/otel-lgtm:0.8.3
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local /DATA/AppData/$AppID/data directory to /data inside the container
+ - type: bind
+ source: /DATA/AppData/$AppID/data
+ target: /data
+ bind:
+ create_host_path: true
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - mode: ingress
+ target: 3000
+ published: "3000"
+ protocol: tcp
+ # Mapping port 4317 of the host to port 4317 of the container
+ - mode: ingress
+ target: 4317
+ published: "4317"
+ protocol: tcp
+ # Mapping port 4318 of the host to port 4318 of the container
+ - mode: ingress
+ target: 4318
+ published: "4318"
+ protocol: tcp
+
+ # Networks to be attached to the container
+ networks:
+ - otel-lgtm
+
+ x-casaos: # CasaOS specific service configuration
+ ports:
+ - container: "3000"
+ description:
+ en_us: WebUI HTTP Port
+ en_uk: WebUI HTTP Port
+ - container: "4317"
+ description:
+ en_us: OpenTelemetry gRPC endpoint
+ en_uk: OpenTelemetry gRPC endpoint
+ - container: "4318"
+ description:
+ en_us: OpenTelemetry HTTP endpoint
+ en_uk: OpenTelemetry HTTP endpoint
+ volumes:
+ - container: /data
+ description:
+ en_us: Data directory
+ en_uk: Data directory
+
+networks:
+ otel-lgtm: | This needs to be `big-bear-otel-lgtm-network` |
big-bear-casaos | github_2023 | others | 2,802 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,118 @@
+# Configuration for otel-lgtm setup
+
+# Name of the otel-lgtm application
+name: otel-lgtm
+
+# Service definitions for otel-lgtm application
+services:
+ # Service name: otel-lgtm
+ # The `otel-lgtm` service definition
+ otel-lgtm:
+ # Name of the container
+ container_name: otel-lgtm
+
+ # Image to be used for the container
+ image: grafana/otel-lgtm:0.8.3
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local /DATA/AppData/$AppID/data directory to /data inside the container
+ - type: bind
+ source: /DATA/AppData/$AppID/data
+ target: /data
+ bind:
+ create_host_path: true
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - mode: ingress
+ target: 3000
+ published: "3000"
+ protocol: tcp
+ # Mapping port 4317 of the host to port 4317 of the container
+ - mode: ingress
+ target: 4317
+ published: "4317"
+ protocol: tcp
+ # Mapping port 4318 of the host to port 4318 of the container
+ - mode: ingress
+ target: 4318
+ published: "4318"
+ protocol: tcp
+
+ # Networks to be attached to the container
+ networks:
+ - otel-lgtm | This needs to be `big-bear-otel-lgtm-network` |
big-bear-casaos | github_2023 | others | 2,802 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,118 @@
+# Configuration for otel-lgtm setup
+
+# Name of the otel-lgtm application
+name: otel-lgtm
+
+# Service definitions for otel-lgtm application
+services:
+ # Service name: otel-lgtm
+ # The `otel-lgtm` service definition
+ otel-lgtm:
+ # Name of the container
+ container_name: otel-lgtm
+
+ # Image to be used for the container
+ image: grafana/otel-lgtm:0.8.3
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local /DATA/AppData/$AppID/data directory to /data inside the container
+ - type: bind
+ source: /DATA/AppData/$AppID/data
+ target: /data
+ bind:
+ create_host_path: true
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 3000 of the host to port 3000 of the container
+ - mode: ingress
+ target: 3000
+ published: "3000"
+ protocol: tcp
+ # Mapping port 4317 of the host to port 4317 of the container
+ - mode: ingress
+ target: 4317
+ published: "4317"
+ protocol: tcp
+ # Mapping port 4318 of the host to port 4318 of the container
+ - mode: ingress
+ target: 4318
+ published: "4318"
+ protocol: tcp
+
+ # Networks to be attached to the container
+ networks:
+ - otel-lgtm
+
+ x-casaos: # CasaOS specific service configuration
+ ports:
+ - container: "3000"
+ description:
+ en_us: WebUI HTTP Port
+ en_uk: WebUI HTTP Port
+ - container: "4317"
+ description:
+ en_us: OpenTelemetry gRPC endpoint
+ en_uk: OpenTelemetry gRPC endpoint
+ - container: "4318"
+ description:
+ en_us: OpenTelemetry HTTP endpoint
+ en_uk: OpenTelemetry HTTP endpoint
+ volumes:
+ - container: /data
+ description:
+ en_us: Data directory
+ en_uk: Data directory
+
+networks:
+ otel-lgtm:
+ driver: bridge
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: otel-lgtm | This needs to be `big-bear-otel-lgtm` |
big-bear-casaos | github_2023 | others | 2,646 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,123 @@
+# Configuration for lyrionmusicserver setup
+
+# Name of the big-bear-lyrionmusicserver application
+name: big-bear-lyrionmusicserver
+
+# Service definitions for the big-bear-lyrionmusicserver application
+services:
+ # Service name: big-bear-lyrionmusicserver
+ # The `big-bear-lyrionmusicserver` service definition
+ big-bear-lyrionmusicserver:
+ # Name of the container
+ container_name: big-bear-lyrionmusicserver
+
+ # Image to be used for the container
+ image: lmscommunity/lyrionmusicserver:9.0.2
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables for the container
+ environment:
+ - HTTP_PORT=9000
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local big-bear-lyrionmusicserver/config directory to /config inside the container
+ - /DATA/AppData/$AppID/config:/config:rw
+
+ # Mounting the local big-bear-lyrionmusicserver/music directory to /music inside the container
+ - /DATA/AppData/$AppID/music:/music:ro
+
+ # Mounting the local big-bear-lyrionmusicserver/playlists directory to /playlist inside the container
+ - /DATA/AppData/$AppID/playlists:/playlist:rw
+
+ # Mounting the local /etc/localtime directory to /etc/localtime inside the container
+ - /etc/localtime:/etc/localtime:ro
+
+ # Mounting the local /etc/timezone directory to /etc/timezone inside the container
+ - /etc/timezone:/etc/timezone:ro
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 9000 of the host to port 9000 of the container
+ - 9000:9000/tcp
+
+ # Mapping port 9090 of the host to port 9090 of the container
+ - 9090:9090/tcp
+
+ # Mapping port 3483 of the host to port 3483 of the container
+ - 3483:3483/tcp
+
+ # Mapping port 3483 of the host to port 3483 of the container
+ - 3483:3483/udp
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: HTTP_PORT
+ description:
+ en_us: "Container Port: 9000"
+ volumes:
+ - container: /config
+ description:
+ en_us: "Container Path: /config"
+ - container: /music
+ description:
+ en_us: "Container Path: /music"
+ - container: /playlist
+ description:
+ en_us: "Container Path: /playlist"
+ - container: /etc/localtime
+ description:
+ en_us: "Container Path: /etc/localtime"
+ - container: /etc/timezone
+ description:
+ en_us: "Container Path: /etc/timezone"
+ ports:
+ - container: "9000"
+ description:
+ en_us: "Container Port: 9000"
+ - container: "9090"
+ description:
+ en_us: "Container Port: 9090"
+ - container: "3483"
+ description:
+ en_us: "Container Port: 3483"
+ - container: "3483"
+ description:
+ en_us: "Container Port: 3483"
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: big-bear-lyrionmusicserver
+ description:
+ # Description in English
+ en_us: Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips. With Homarr, you can access and control everything in one convenient location. Homarr seamlessly integrates with the apps you've added, providing you with valuable information and giving you complete control. Installation is a breeze, and Homarr supports a wide range of deployment methods. | _:warning: Potential issue_
**Fix incorrect application description.**
The current description appears to be copied from Homarr dashboard application. Please update it with the correct description for LyriOn Music Server.
```diff
description:
en_us: >
- Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips. With Homarr, you can access and control everything in one convenient location. Homarr seamlessly integrates with the apps you've added, providing you with valuable information and giving you complete control. Installation is a breeze, and Homarr supports a wide range of deployment methods.
+ LyriOn Music Server is a comprehensive streaming audio server that lets you manage and stream your music collection across your network. It supports various audio formats, provides smart playlists, and offers multi-room audio synchronization capabilities. With its powerful web interface, you can control your music from any device and enjoy your collection with high-quality audio playback.
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
# Description in English
en_us: LyriOn Music Server is a comprehensive streaming audio server that lets you manage and stream your music collection across your network. It supports various audio formats, provides smart playlists, and offers multi-room audio synchronization capabilities. With its powerful web interface, you can control your music from any device and enjoy your collection with high-quality audio playback.
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,616 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,88 @@
+# Configuration for unms setup
+
+# Name of the big-bear-unms application
+name: big-bear-unms | _:hammer_and_wrench: Refactor suggestion_
**Ensure naming consistency across the configuration.**
The application name `big-bear-unms` differs from the service name `big-bear-uisp`. Consider using consistent naming to avoid confusion, preferably using `uisp` as it's the current official name of the product.
```diff
-name: big-bear-unms
+name: big-bear-uisp
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
name: big-bear-uisp
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,555 | bigbeartechworld | coderabbitai[bot] | @@ -2,7 +2,7 @@
"id": "pterodactyl-wings",
"version": "1.11.13",
"image": "ghcr.io/pterodactyl/wings",
- "youtube": "",
+ "youtube": "https://youtu.be/p_140cc6_1g", | _:bulb: Codebase verification_
**Consider separate tutorial videos for Panel and Wings**
While both components are part of the Pterodactyl system, separate tutorials would better serve users by:
- Providing focused guidance for each component's specific setup and configuration
- Making it easier to find relevant information when working with a particular component
- Following the repository's pattern where distinct components have dedicated tutorials
<details>
<summary>π Analysis chain</summary>
**Consider separate tutorial videos for Panel and Wings**
The same YouTube video (p_140cc6_1g) is used for both Pterodactyl Panel and Wings configurations. While this might be intentional if it's a comprehensive tutorial, consider whether separate, focused videos for each component would be more beneficial for users.
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Description: Check if the same video is appropriate for both components
VIDEO_ID="p_140cc6_1g"
echo "Checking video metadata..."
if [ -x "$(command -v yt-dlp)" ]; then
echo "Video title and description:"
yt-dlp --skip-download --print title --print description "https://youtu.be/${VIDEO_ID}"
fi
# Check for any existing separate videos
echo "Searching repository for other potential video references..."
rg -l "pterodactyl.*wings.*youtube" || true
rg -l "pterodactyl.*panel.*youtube" || true
```
Length of output: 343
---
Script:
```shell
#!/bin/bash
# Search for YouTube URLs and tutorial references
echo "Searching for YouTube URLs in configs..."
fd -e json -x cat {} \; | grep -i "youtube\|video"
echo -e "\nSearching for tutorial references in docs..."
fd -e md -x cat {} \; | grep -i "tutorial\|guide\|video" || true
echo -e "\nChecking config file structure..."
fd "config.json" -x cat {}
```
Length of output: 52321
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,548 | bigbeartechworld | coderabbitai[bot] | @@ -8,29 +8,24 @@ services:
# Service name: big-bear-romm
# The `big-bear-romm` service definition
big-bear-romm:
- image: rommapp/romm:3.7.0-alpha.1 # Docker image for the application
+ image: rommapp/romm:3.7.0 # Docker image for the application
container_name: big-bear-romm
environment:
- DB_HOST=big-bear-rommdb # Hostname of the MariaDB container
- DB_PORT=3306 # Port used for MariaDB
- DB_USER=romm-user # Database user for MariaDB
- DB_NAME=romm # Name of the database (Should match the MYSQL_DATABASE value in the mariadb container)
- DB_PASSWD=casaos # Database password (Should match the MYSQL_PASSWORD value in the mariadb container)
- - IGDB_CLIENT_ID=<IGDB client id> # IGDB client ID
- - IGDB_CLIENT_SECRET=<IGDB client secret> # IGDB client secret
- # [Optional] Enable user management and require authentication to access the interface (disabled by default)
- ROMM_AUTH_SECRET_KEY=<secret key> # Authentication secret key (Generate a key with `openssl rand -hex 32`)
- - ROMM_AUTH_USERNAME=admin # Authentication username (default: admin)
- - ROMM_AUTH_PASSWORD=casaos # Authentication password (default: admin)
+ # [Optional] Enable metadata providers (all disabled by default)
+ - IGDB_CLIENT_ID=<igdb client id> # Generate an ID and SECRET in IGDB
+ - IGDB_CLIENT_SECRET=<igdb client secret> # https://api-docs.igdb.com/#account-creation
+ - MOBYGAMES_API_KEY=<moby api key> # https://www.mobygames.com/info/api/
+ - STEAMGRIDDB_API_KEY=<sgdb api key> # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb | _:hammer_and_wrench: Refactor suggestion_
**New metadata provider configuration added**
Good addition of optional metadata providers with documentation links. However, the environment variables in the x-casaos section haven't been updated to include these new options.
Add the following environment variables to the x-casaos section:
```diff
x-casaos:
envs:
+ - container: MOBYGAMES_API_KEY
+ description:
+ en_us: "MobyGames API Key (Optional): Generate at https://www.mobygames.com/info/api/"
+ - container: STEAMGRIDDB_API_KEY
+ description:
+ en_us: "SteamGridDB API Key (Optional): See https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb"
```
> Committable suggestion skipped: line range outside the PR's diff.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,548 | bigbeartechworld | dragonfire1119 | @@ -1,8 +1,8 @@
{
- "id": "Romm",
- "version": "3.7.0-alpha.1",
- "image": "zurdi15/romm",
+ "id": "RomM", | This must be `Romm` because it should match the directory. |
big-bear-casaos | github_2023 | others | 2,548 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,196 @@
+# Configuration for romm setup
+
+# Name of the big-bear-romm application
+name: big-bear-romm
+
+# Service definitions for the big-bear-romm application
+services:
+ # Service name: big-bear-romm
+ # The `big-bear-romm` service definition
+ big-bear-romm:
+ image: rommapp/romm:3.7.0 # Docker image for the application
+ container_name: big-bear-romm
+ environment:
+ - DB_HOST=big-bear-rommdb # Hostname of the MariaDB container
+ - DB_PORT=3306 # Port used for MariaDB
+ - DB_USER=romm-user # Database user for MariaDB
+ - DB_NAME=romm # Name of the database (Should match the MYSQL_DATABASE value in the mariadb container)
+ - DB_PASSWD=casaos # Database password (Should match the MYSQL_PASSWORD value in the mariadb container)
+ - ROMM_AUTH_SECRET_KEY=<secret key> # Authentication secret key (Generate a key with `openssl rand -hex 32`)
+ # [Optional] Enable metadata providers (all disabled by default)
+ - IGDB_CLIENT_ID=<igdb client id> # Generate an ID and SECRET in IGDB
+ - IGDB_CLIENT_SECRET=<igdb client secret> # https://api-docs.igdb.com/#account-creation
+ - MOBYGAMES_API_KEY=<moby api key> # https://www.mobygames.com/info/api/
+ - STEAMGRIDDB_API_KEY=<sgdb api key> # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb
+ # [Optional] Enable asynchronous tasks (all disabled by default)
+ - ENABLE_RESCAN_ON_FILESYSTEM_CHANGE=true # Enable rescan on filesystem change
+ - ENABLE_SCHEDULED_RESCAN=true # Enable scheduled rescan
+ - ENABLE_SCHEDULED_UPDATE_SWITCH_TITLEDB=true # Enable scheduled update of Switch TitleDB database
+ volumes:
+ - "/DATA/AppData/$AppID/resources:/romm/resources" # [Optional] Path where roms metadata (covers) are stored
+ - "/DATA/AppData/$AppID/redis-data:/redis-data" # Cached data for background tasks
+ - "/DATA/AppData/$AppID/library:/romm/library" # Path to the roms library
+ - "/DATA/AppData/$AppID/assets:/romm/assets" # Uploaded saves, states, etc.
+ - "/DATA/AppData/$AppID/config:/romm/config" # [Optional] Path where config is stored
+ - "/DATA/AppData/$AppID/logs:/romm/logs" # [Optional] Path where logs are stored
+ ports:
+ - 1080:8080 # Map host port 1080 to container port 8080
+ depends_on:
+ - big-bear-rommdb # Make sure the romm_db service is started before the app service
+ restart: "unless-stopped"
+ networks:
+ - big-bear-romm-network # Use the big-bear-romm-network network
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ # Environment variables for CasaOS
+ - container: DB_HOST
+ description:
+ en_us: "Database Host: romm_db"
+ - container: DB_PORT
+ description:
+ en_us: "Database Port: 3306"
+ - container: DB_USER
+ description:
+ en_us: "Database User: romm-user"
+ - container: DB_NAME
+ description:
+ en_us: "Database Name: romm"
+ - container: DB_PASSWD
+ description:
+ en_us: "Database Password: casaos"
+ - container: IGDB_CLIENT_ID
+ description:
+ en_us: "IGDB Client ID (Optional): Generate an ID and SECRET in IGDB"
+ - container: IGDB_CLIENT_SECRET
+ description:
+ en_us: "IGDB Client Secret (Optional): https://api-docs.igdb.com/#account-creation"
+ - container: MOBYGAMES_API_KEY
+ description:
+ en_us: "MobyGames API Key (Optional): Generate at https://www.mobygames.com/info/api/"
+ - container: STEAMGRIDDB_API_KEY
+ description:
+ en_us: "SteamGridDB API Key (Optional): See https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb"
+ - container: ROMM_AUTH_SECRET_KEY
+ description:
+ en_us: "Authentication Secret Key: <secret key>"
+ - container: ENABLE_RESCAN_ON_FILESYSTEM_CHANGE
+ description:
+ en_us: "Rescan On Filesystem Change: true"
+ - container: ENABLE_SCHEDULED_RESCAN
+ description:
+ en_us: "Scheduled Rescan: true"
+ - container: ENABLE_SCHEDULED_UPDATE_SWITCH_TITLEDB
+ description:
+ en_us: "Scheduled Update Switch TitleDB: true"
+ volumes:
+ # Volume mappings for CasaOS
+ - container: /romm/resources
+ description:
+ en_us: "Container Path: /romm/resources"
+ - container: /romm/library
+ description:
+ en_us: "Container Path: /romm/library"
+ - container: /romm/assets
+ description:
+ en_us: "Container Path: /romm/assets"
+ - container: /romm/config
+ description:
+ en_us: "Container Path: /romm/config"
+ - container: /romm/logs
+ description:
+ en_us: "Container Path: /romm/logs"
+ ports:
+ # Port mappings for CasaOS
+ - container: "8080"
+ description:
+ en_us: "Container Port: 8080"
+
+ # MariaDB service for rommdb
+ big-bear-rommdb:
+ image: mariadb:latest
+ container_name: big-bear-rommdb
+ environment:
+ - MYSQL_ROOT_PASSWORD=casaos # MariaDB root password
+ - MYSQL_DATABASE=romm # MariaDB database name
+ - MYSQL_USER=romm-user # MariaDB user
+ - MYSQL_PASSWORD=casaos # MariaDB password | _:hammer_and_wrench: Refactor suggestion_
**Review database security configuration.**
Consider the following security recommendations:
1. Avoid hardcoding database credentials
2. Use stronger passwords than "casaos"
Consider using environment variables or Docker secrets for database credentials.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,548 | bigbeartechworld | dragonfire1119 | @@ -174,6 +173,7 @@ If you have a suggestion for an app, please post in the [BigBearCommunity](https
| reactive-resume | amruthpillai/reactive-resume | 4.1.8 | | |
| retroarch-web | inglebard/retroarch-web | latest | | |
| rocket-chat | rocket.chat | 6.13.1 | | |
+| romm | rommapp/romm | 3.7.0 | | [Docs](https://github.com/rommapp/romm/wiki) | | The README gets autogenerated only files need changes are in the Apps directory. |
big-bear-casaos | github_2023 | others | 2,490 | bigbeartechworld | coderabbitai[bot] | @@ -12,7 +12,7 @@ services:
container_name: big-bear-seafile
# Image to be used for the container
- image: seafileltd/seafile-mc:12.0.6
+ image: seafileltd/seafile-mc:11.0.6 | _:warning: Potential issue_
**Review security implications of version downgrade**
Two security concerns to address:
1. Verify if Seafile 11.0.6 has any known security vulnerabilities
2. The database root password is hardcoded in the configuration
Recommendations:
1. Document any known security implications of using version 11.0.6
2. Consider using environment variables or secrets management for sensitive data
```shell
#!/bin/bash
# Check for security advisories
curl -s "https://manual.seafile.com/security/security_advisory/" | grep -i "11.0.6"
# Search for existing environment variable usage patterns
rg -p "DB_ROOT_PASSWD|MYSQL_ROOT_PASSWORD" --type yaml
```
Also applies to: 52-52
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,470 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,87 @@
+# Configuration for lobe-chat setup
+
+# Name of the big-bear-lobe-chat application
+name: big-bear-lobe-chat
+
+# Service definitions for the big-bear-lobe-chat application
+services:
+ # Service name: big-bear-lobe-chat
+ # The `big-bear-lobe-chat` service definition
+ big-bear-lobe-chat:
+ # Name of the container
+ container_name: big-bear-lobe-chat
+
+ # Image to be used for the container
+ image: lobehub/lobe-chat:v1.42.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Environment variables for the container
+ environment:
+ - OPENAI_API_KEY=""
+ - OPENAI_PROXY_URL=""
+ - CUSTOM_MODELS=""
+ - ACCESS_CODE=""
+ | _:hammer_and_wrench: Refactor suggestion_
**Add validation for required environment variables**
All environment variables are currently empty. Consider:
1. Documenting which variables are required vs optional
2. Adding validation in the application startup to check for required variables
3. Providing example values in comments
```diff
environment:
- - OPENAI_API_KEY=""
- - OPENAI_PROXY_URL=""
- - CUSTOM_MODELS=""
- - ACCESS_CODE=""
+ # Required: Your OpenAI API key
+ - OPENAI_API_KEY=
+ # Optional: Proxy URL for OpenAI API
+ - OPENAI_PROXY_URL=
+ # Optional: Comma-separated list of custom model names
+ - CUSTOM_MODELS=
+ # Optional: Set an access code for added security
+ - ACCESS_CODE=
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
environment:
# Required: Your OpenAI API key
- OPENAI_API_KEY=
# Optional: Proxy URL for OpenAI API
- OPENAI_PROXY_URL=
# Optional: Comma-separated list of custom model names
- CUSTOM_MODELS=
# Optional: Set an access code for added security
- ACCESS_CODE=
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,468 | bigbeartechworld | coderabbitai[bot] | @@ -22,10 +22,25 @@ services:
environment:
# Set to true to download security jar (required for authentication login)
- DOCKER_ENABLE_SECURITY=false
-
+
+ # Set to true to enable login for authentication
+ - SECURITY_ENABLE_LOGIN=true
+
+ # Set the initial admin username
+ - SECURITY_INITIALLOGIN_USERNAME=bigbear
+
+ # Set the initial admin password
+ - SECURITY_INITIALLOGIN_PASSWORD=4500733e-a0f8-4605-a712-fd267404956a | _:warning: Potential issue_
**Security: Move credentials to environment files**
Storing credentials in version control, even if they're UUIDs, is a security risk. Consider:
1. Moving credentials to a `.env` file (added to .gitignore)
2. Using Docker secrets for sensitive data
3. Documenting the need to change default credentials
Example implementation using an env file:
```diff
- - SECURITY_INITIALLOGIN_USERNAME=bigbear
- - SECURITY_INITIALLOGIN_PASSWORD=4500733e-a0f8-4605-a712-fd267404956a
+ - SECURITY_INITIALLOGIN_USERNAME=${ADMIN_USERNAME}
+ - SECURITY_INITIALLOGIN_PASSWORD=${ADMIN_PASSWORD}
```
Create a `.env` file (not committed to git):
```env
ADMIN_USERNAME=your_username
ADMIN_PASSWORD=your_secure_password
```
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ Gitleaks (8.21.2)</summary>
33-33: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,468 | bigbeartechworld | coderabbitai[bot] | @@ -22,10 +22,25 @@
environment:
# Set to true to download security jar (required for authentication login)
- DOCKER_ENABLE_SECURITY=false
-
+
+ # Set to true to enable login for authentication
+ - SECURITY_ENABLE_LOGIN=true | _:warning: Potential issue_
**Resolve conflicting security settings**
There's a contradiction in the security configuration:
- `DOCKER_ENABLE_SECURITY=false` disables the security jar
- `SECURITY_ENABLE_LOGIN=true` enables authentication
- The documentation states that the security jar is required for authentication
This configuration will likely prevent authentication from working properly.
Please enable both features or document why they should have different settings:
```diff
- - DOCKER_ENABLE_SECURITY=false
+ - DOCKER_ENABLE_SECURITY=true
- SECURITY_ENABLE_LOGIN=true
```
> Committable suggestion skipped: line range outside the PR's diff.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,243 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,78 @@
+# Configuration for playit-docker-web setup
+
+# Name of the big-bear-playit-docker-web application
+name: big-bear-playit-docker-web
+
+# Service definitions for the big-bear-playit-docker-web application
+services:
+ # Service name: big-bear-playit-docker-web
+ # The `big-bear-playit-docker-web` service definition
+ big-bear-playit-docker-web:
+ # Name of the container
+ container_name: big-bear-playit-docker-web
+
+ # Image to be used for the container
+ image: wisdomsky/playit-docker-web:1.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Network mode
+ network_mode: host
+
+ # Environment variables for the container
+ environment:
+ - WEBUI_PORT=8008
+
+ # Volumes to be mounted to the container
+ volumes:
+ - /DATA/AppData/$AppID/config:/config
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: WEBUI_PORT
+ description:
+ en_us: "Container Environment Variable: WEBUI_PORT"
+ volumes:
+ - container: /config
+ description:
+ en_us: "Container Path: /config"
+ ports:
+ - container: "8008"
+ description:
+ en_us: "Container Port: 8008"
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: big-bear-cloudflared-web | _:warning: Potential issue_
**Fix incorrect main service reference**
The main service is incorrectly set to `big-bear-cloudflared-web` instead of `big-bear-playit-docker-web`. This mismatch could cause issues with CasaOS service management.
```diff
- main: big-bear-cloudflared-web
+ main: big-bear-playit-docker-web
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
main: big-bear-playit-docker-web
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,243 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,78 @@
+# Configuration for playit-docker-web setup
+
+# Name of the big-bear-playit-docker-web application
+name: big-bear-playit-docker-web
+
+# Service definitions for the big-bear-playit-docker-web application
+services:
+ # Service name: big-bear-playit-docker-web
+ # The `big-bear-playit-docker-web` service definition
+ big-bear-playit-docker-web:
+ # Name of the container
+ container_name: big-bear-playit-docker-web
+
+ # Image to be used for the container
+ image: wisdomsky/playit-docker-web:1.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Network mode
+ network_mode: host
+
+ # Environment variables for the container
+ environment:
+ - WEBUI_PORT=8008
+
+ # Volumes to be mounted to the container
+ volumes:
+ - /DATA/AppData/$AppID/config:/config
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: WEBUI_PORT
+ description:
+ en_us: "Container Environment Variable: WEBUI_PORT"
+ volumes:
+ - container: /config
+ description:
+ en_us: "Container Path: /config"
+ ports:
+ - container: "8008"
+ description:
+ en_us: "Container Port: 8008"
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: big-bear-cloudflared-web
+ description:
+ # Description in English
+ en_us: Playit.gg is a global proxy that allows anyone to host a server without port forwarding. We use tunneling. Only the server needs to run the program, not every player!
+ tagline:
+ # Short description or tagline in English
+ en_us: Playit.gg is a global proxy that allows anyone to host a server without port forwarding.
+ # Developer's name or identifier
+ developer: "wisdomsky"
+ # Author of this configuration
+ author: BigBearTechWorld
+ # Icon for the application
+ icon: https://cdn.jsdelivr.net/gh/bigbeartechworld/big-bear-casaos/Apps/playit-docker-web/logo.png
+ # Thumbnail image (currently empty)
+ thumbnail: ""
+ title:
+ # Title in English
+ en_us: Playit Docker Web
+ # Application category
+ category: BigBearCasaOS
+ # Port mapping information
+ port_map: "8008"
+ # Tips
+ tips:
+ before_install:
+ en_us: |
+ Read this before installing: https://community.bigbeartechworld.com/t/added-cloudflared-web-to-bigbearcasaos/2275?u=dragonfire1119 | _:warning: Potential issue_
**Fix incorrect documentation link**
The installation tips reference Cloudflared Web instead of Playit Docker Web. This appears to be a copy-paste error.
```diff
before_install:
en_us: |
- Read this before installing: https://community.bigbeartechworld.com/t/added-cloudflared-web-to-bigbearcasaos/2275?u=dragonfire1119
+ Read this before installing: <insert correct Playit Docker Web documentation URL>
```
> Committable suggestion skipped: line range outside the PR's diff.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,241 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,92 @@
+# Configuration for cloudflared-web setup
+
+# Name of the big-bear-cloudflared-web application
+name: big-bear-cloudflared-web
+
+# Service definitions for the big-bear-cloudflared-web application
+services:
+ # Service name: big-bear-cloudflared-web
+ # The `big-bear-cloudflared-web` service definition
+ big-bear-cloudflared-web:
+ # Name of the container
+ container_name: big-bear-cloudflared-web
+
+ # Image to be used for the container
+ image: wisdomsky/cloudflared-web:2024.11.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Network mode
+ network_mode: host
+
+ # Environment variables for the container
+ environment:
+ - WEBUI_PORT=14333
+ - EDGE_IP_VERSION=auto
+ - PROTOCOL=auto
+ - METRICS_ENABLE=false
+ - METRICS_PORT=60123
+ - BASIC_AUTH_USER=admin
+ - BASIC_AUTH_PASS="" | _:warning: Potential issue_
**Security: Empty basic auth password is a security risk**
The `BASIC_AUTH_PASS` is set to an empty string, which effectively disables authentication when combined with the default admin username. This could expose the web UI to unauthorized access.
Consider:
1. Making the password a required configuration
2. Adding a warning in the installation tips about setting a strong password
3. Implementing a secure default state
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,241 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,92 @@
+# Configuration for cloudflared-web setup
+
+# Name of the big-bear-cloudflared-web application
+name: big-bear-cloudflared-web
+
+# Service definitions for the big-bear-cloudflared-web application
+services:
+ # Service name: big-bear-cloudflared-web
+ # The `big-bear-cloudflared-web` service definition
+ big-bear-cloudflared-web:
+ # Name of the container
+ container_name: big-bear-cloudflared-web
+ | _:warning: Potential issue_
**Add volume mounts for persistence**
The configuration lacks volume mounts for persisting tunnel configurations and credentials. Without persistence, tunnel configurations will be lost when the container is recreated.
Add volume mounts:
```diff
container_name: big-bear-cloudflared-web
+ volumes:
+ - ./data:/root/.cloudflared
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
container_name: big-bear-cloudflared-web
volumes:
- ./data:/root/.cloudflared
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,241 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,92 @@
+# Configuration for cloudflared-web setup
+
+# Name of the big-bear-cloudflared-web application
+name: big-bear-cloudflared-web
+
+# Service definitions for the big-bear-cloudflared-web application
+services:
+ # Service name: big-bear-cloudflared-web
+ # The `big-bear-cloudflared-web` service definition
+ big-bear-cloudflared-web:
+ # Name of the container
+ container_name: big-bear-cloudflared-web
+
+ # Image to be used for the container
+ image: wisdomsky/cloudflared-web:2024.11.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Network mode
+ network_mode: host
+
+ # Environment variables for the container
+ environment:
+ - WEBUI_PORT=14333
+ - EDGE_IP_VERSION=auto
+ - PROTOCOL=auto
+ - METRICS_ENABLE=false
+ - METRICS_PORT=60123
+ - BASIC_AUTH_USER=admin
+ - BASIC_AUTH_PASS=""
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: WEBUI_PORT
+ description:
+ en_us: "Web UI Port"
+ - container: EDGE_IP_VERSION
+ description:
+ en_us: "Edge IP Version"
+ - container: PROTOCOL
+ description:
+ en_us: "Protocol"
+ - container: METRICS_ENABLE
+ description:
+ en_us: "Metrics Enable"
+ - container: METRICS_PORT
+ description:
+ en_us: "Metrics Port"
+ - container: BASIC_AUTH_USER
+ description:
+ en_us: "Basic Auth User"
+ - container: BASIC_AUTH_PASS
+ ports:
+ - container: "14333"
+ description:
+ en_us: "Container Port: 14333"
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+ - arm64
+ # Main service of the application
+ main: big-bear-cloudflared-web
+ description:
+ # Description in English
+ en_us: Cloudflared-web is a docker image that packages both cloudflared cli and a simple Web UI to easily start or stop remotely-managed Cloudflare tunnel.
+ tagline:
+ # Short description or tagline in English
+ en_us: Cloudflared Web
+ # Developer's name or identifier
+ developer: "wisdomsky"
+ # Author of this configuration
+ author: BigBearTechWorld
+ # Icon for the application
+ icon: https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/cloudflare.png
+ # Thumbnail image (currently empty)
+ thumbnail: ""
+ title:
+ # Title in English
+ en_us: Cloudflared Web
+ # Application category
+ category: BigBearCasaOS
+ # Port mapping information
+ port_map: "14333"
+ # Tips
+ tips:
+ before_install:
+ en_us: |
+ Read this before installing: https://community.bigbeartechworld.com/t/added-cloudflared-web-to-bigbearcasaos/2275?u=dragonfire1119 | _:bulb: Codebase verification_
**Community link is accessible, but installation tips need enhancement**
The community link is valid and accessible (HTTP 200 response). However, the current setup lacks essential information directly in the compose file. Consider:
- Adding basic inline setup instructions for quick reference
- Including security recommendations
- Adding health check configuration as suggested
Example enhancement:
```yaml
tips:
before_install:
en_us: |
Quick setup:
1. Configure your Cloudflare credentials
2. Set up tunnel authentication
3. Ensure ports 14333 and 8080 are available
For detailed instructions: https://community.bigbeartechworld.com/t/added-cloudflared-web-to-bigbearcasaos/2275?u=dragonfire1119
Security recommendations:
- Use secure credentials storage
- Regularly update the image
- Monitor tunnel status
```
<details>
<summary>π Analysis chain</summary>
**Verify the community link and enhance installation tips**
While providing a community link is helpful, consider:
1. Adding basic setup instructions inline
2. Including security recommendations
3. Adding a health check configuration
Add health check configuration:
```diff
image: wisdomsky/cloudflared-web:2024.11.1
+ healthcheck:
+ test: ["CMD", "curl", "-f", "http://localhost:14333"]
+ interval: 30s
+ timeout: 10s
+ retries: 3
```
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Verify if the community link is accessible
curl -I "https://community.bigbeartechworld.com/t/added-cloudflared-web-to-bigbearcasaos/2275"
```
Length of output: 1716
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,241 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,92 @@
+# Configuration for cloudflared-web setup
+
+# Name of the big-bear-cloudflared-web application
+name: big-bear-cloudflared-web
+
+# Service definitions for the big-bear-cloudflared-web application
+services:
+ # Service name: big-bear-cloudflared-web
+ # The `big-bear-cloudflared-web` service definition
+ big-bear-cloudflared-web:
+ # Name of the container
+ container_name: big-bear-cloudflared-web
+
+ # Image to be used for the container
+ image: wisdomsky/cloudflared-web:2024.11.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Network mode
+ network_mode: host
+
+ # Environment variables for the container
+ environment:
+ - WEBUI_PORT=14333
+ - EDGE_IP_VERSION=auto
+ - PROTOCOL=auto
+ - METRICS_ENABLE=false
+ - METRICS_PORT=60123
+ - BASIC_AUTH_USER=admin
+ - BASIC_AUTH_PASS=""
+
+ x-casaos: # CasaOS specific configuration
+ envs:
+ - container: WEBUI_PORT
+ description:
+ en_us: "Web UI Port"
+ - container: EDGE_IP_VERSION
+ description:
+ en_us: "Edge IP Version"
+ - container: PROTOCOL
+ description:
+ en_us: "Protocol"
+ - container: METRICS_ENABLE
+ description:
+ en_us: "Metrics Enable"
+ - container: METRICS_PORT
+ description:
+ en_us: "Metrics Port"
+ - container: BASIC_AUTH_USER
+ description:
+ en_us: "Basic Auth User"
+ - container: BASIC_AUTH_PASS
+ ports:
+ - container: "14333"
+ description:
+ en_us: "Container Port: 14333"
+ | _:hammer_and_wrench: Refactor suggestion_
**Enhance environment variable configuration**
The environment variable definitions could be improved with:
1. Validation rules for ports and IP versions
2. Marking sensitive fields (like BASIC_AUTH_PASS)
3. Default values where appropriate
Add validation and sensitivity markers:
```diff
- container: BASIC_AUTH_PASS
+ sensitive: true
+ description:
+ en_us: "Basic Auth Password (required)"
+ - container: WEBUI_PORT
+ validation:
+ min: 1024
+ max: 65535
+ default: "14333"
```
> Committable suggestion skipped: line range outside the PR's diff.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,241 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,92 @@
+# Configuration for cloudflared-web setup
+
+# Name of the big-bear-cloudflared-web application
+name: big-bear-cloudflared-web
+
+# Service definitions for the big-bear-cloudflared-web application
+services:
+ # Service name: big-bear-cloudflared-web
+ # The `big-bear-cloudflared-web` service definition
+ big-bear-cloudflared-web:
+ # Name of the container
+ container_name: big-bear-cloudflared-web
+
+ # Image to be used for the container
+ image: wisdomsky/cloudflared-web:2024.11.1
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Network mode
+ network_mode: host | _:warning: Potential issue_
**Security: Reconsider using host network mode**
Using `network_mode: host` gives the container full access to the host's network stack, which violates the principle of least privilege. Consider using bridge networking with specific port mappings instead.
```diff
- network_mode: host
+ networks:
+ - cloudflared_network
+ ports:
+ - "14333:14333"
```
> Committable suggestion skipped: line range outside the PR's diff.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,213 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,86 @@
+# Docker Compose configuration for BigBearCasaOS Stirling PDF Service
+# This service provides a web interface for a Local hosted web based PDF editor
+
+# Name of the big-bear-stirling-pdf application
+name: big-bear-stirling-pdf
+
+# Service definitions for the big-bear-stirling-pdf application
+services:
+ # Main service configuration for the CasaOS User Management application
+ # This service provides a web interface running on port 5000 for user administration
+ big-bear-stirling-pdf:
+ # Name of the container
+ container_name: big-bear-stirling-pdf
+
+ # Image to be used for the container specifies the stirling-pdf version and source
+ image: stirlingtools/stirling-pdf:0.35.0
+
+ # Container restart policy - restarts the container unless manually stopped
+ restart: unless-stopped
+
+ # Environment variables for service configuration
+ environment:
+ # Set to true to download security jar (required for authentication login)
+ - DOCKER_ENABLE_SECURITY=false
+
+ # Download Calibre onto Stirling-PDF to enable PDF to/from book and advanced HTML conversion
+ - INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
+
+ # Define custom font libraries to install for document conversions
+ - LANGS=en_US | _:bulb: Codebase verification_
_:warning: Potential issue_
**Security implications need to be documented**
The codebase lacks proper documentation about security implications of the `DOCKER_ENABLE_SECURITY` setting. The only references to security are in the docker-compose.yml file, which merely states that it's "required for authentication login" without explaining the risks of disabling it. Recommend:
1. Adding clear security documentation explaining the risks of running without authentication
2. Including setup instructions for secure production deployments
3. Consider changing the default to `true` for better security-by-default
<details>
<summary>π Analysis chain</summary>
**Review security implications of disabled authentication.**
Setting `DOCKER_ENABLE_SECURITY=false` disables authentication, which could expose the PDF processing service to unauthorized access. Consider:
1. Documenting the security implications in the installation tips
2. Enabling security by default for production environments
3. Adding guidance for secure configuration
Let's check if there's any documentation about security implications:
---
Let me search for more context about security documentation in other files.
---
Let me try a different approach to find security-related documentation.
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Search for security-related documentation
rg -i "security|authentication|auth" Apps/stirling-pdf/
```
Length of output: 477
---
Script:
```shell
#!/bin/bash
# Search for README files and their content
fd README.md Apps/stirling-pdf/ -x cat {}
# Search for security-related configuration or documentation in other common locations
fd "SECURITY|security" Apps/stirling-pdf/
```
Length of output: 89
---
Script:
```shell
#!/bin/bash
# Search for documentation about security in markdown files and configuration
rg -i -g '*.{md,yml,yaml,txt}' 'security|authentication|auth' Apps/stirling-pdf/ -A 3 -B 3
# Look for any security-related code or configuration files
fd . Apps/stirling-pdf/ --type f --exec file {} | grep -i "security"
```
Length of output: 2081
</details>
<details>
<summary>π§° Tools</summary>
<details>
<summary>πͺ yamllint (1.35.1)</summary>
[error] 25-25: trailing spaces
(trailing-spaces)
---
[error] 28-28: trailing spaces
(trailing-spaces)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,185 | bigbeartechworld | coderabbitai[bot] | @@ -30,30 +34,33 @@ services:
# Specifies the admin password for the service
- ADMIN_PASSWORD=casaos
- # Mount necessary volumes for accessing system information
+ # Volume mappings required for system integration
+ # These mounts allow the container to interact with the host system
volumes:
- # Mounting the cgroup filesystem in read-only mode for system resource monitoring
+ # Required for monitoring system resources and container metrics
- /sys/fs/cgroup:/sys/fs/cgroup:ro
- # Persisting CasaOS database files to retain data across container restarts
+ # Persistent storage for CasaOS database to maintain user data
- /var/lib/casaos/db:/var/lib/casaos/db
- # Mounting systemd's runtime directory for integration with the host system
+ # Access to systemd for service management and system integration
- /run/systemd/system:/run/systemd/system
- # Providing access to the D-Bus system bus for communication with host services
+ # D-Bus socket for system communication and service discovery
- /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket
- # Map port 7681 on the host to port 7681 on the container
+ # Map port 5000 on the host to port 5000 on the container
ports:
- "5000:5000"
+ # Additional container capabilities
cap_add:
- # Adds the SYS_ADMIN capability to the container for advanced administrative actions
+ # Required for system administration tasks within the container
- SYS_ADMIN
+ # Security options for container runtime
security_opt:
- # Disables the default seccomp security profile to allow unrestricted system calls
+ # Allows necessary system calls for full functionality
- seccomp:unconfined | _:warning: Potential issue_
**Security concern: Unconfined seccomp profile**
Using `seccomp:unconfined` significantly reduces container security by allowing all system calls. This should be replaced with a custom seccomp profile that only allows necessary system calls.
Consider:
1. Creating a custom seccomp profile
2. Documenting required system calls
3. Using default seccomp profile if possible
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,185 | bigbeartechworld | coderabbitai[bot] | @@ -20,6 +22,8 @@ services:
# Run the container in privileged mode to allow access to system metrics
privileged: true | _:warning: Potential issue_
**Security concern: Container runs in privileged mode**
Running containers in privileged mode grants extensive host system access, which violates the principle of least privilege. Consider:
1. Identifying specific capabilities needed instead of using privileged mode
2. Using `cap_add` for only required capabilities
Suggested approach:
```diff
- privileged: true
+ cap_add:
+ - SYS_PTRACE # If process monitoring is needed
+ - NET_ADMIN # If network administration is required
```
> Committable suggestion skipped: line range outside the PR's diff.
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,185 | bigbeartechworld | coderabbitai[bot] | @@ -30,30 +34,33 @@ services:
# Specifies the admin password for the service
- ADMIN_PASSWORD=casaos
- # Mount necessary volumes for accessing system information
+ # Volume mappings required for system integration
+ # These mounts allow the container to interact with the host system
volumes:
- # Mounting the cgroup filesystem in read-only mode for system resource monitoring
+ # Required for monitoring system resources and container metrics
- /sys/fs/cgroup:/sys/fs/cgroup:ro
- # Persisting CasaOS database files to retain data across container restarts
+ # Persistent storage for CasaOS database to maintain user data
- /var/lib/casaos/db:/var/lib/casaos/db
- # Mounting systemd's runtime directory for integration with the host system
+ # Access to systemd for service management and system integration
- /run/systemd/system:/run/systemd/system
- # Providing access to the D-Bus system bus for communication with host services
+ # D-Bus socket for system communication and service discovery
- /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket
- # Map port 7681 on the host to port 7681 on the container
+ # Map port 5000 on the host to port 5000 on the container
ports:
- "5000:5000" | _:bulb: Codebase verification_
**Port 5000 conflicts detected with multiple CasaOS apps**
There are direct port conflicts with several other CasaOS applications that also use port 5000 on the host:
- LibreTranslate: `"5000:5000"`
- Kavita: `"5000:5000"`
- ChangeDetection: `"5000:5000"`
- Ayon: `"5000:5000"`
Consider using a different host port to avoid conflicts with these existing services. For example, you could map to a unique host port like: `"5001:5000"` or `"15000:5000"`.
<details>
<summary>π Analysis chain</summary>
**Verify port 5000 availability and conflicts**
Port 5000 is commonly used by development servers and other services. Ensure this port choice doesn't conflict with other CasaOS services.
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Search for other services using port 5000
rg -l "5000" | grep -i "docker-compose.yml"
```
Length of output: 361
---
Script:
```shell
#!/bin/bash
# Check the specific port mappings in each docker-compose file
for file in $(rg -l "5000" | grep -i "docker-compose.yml"); do
echo "=== $file ==="
rg ":[\"']?5000[\"']?" -A 1 -B 1 "$file"
done
```
Length of output: 3233
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 2,185 | bigbeartechworld | coderabbitai[bot] | @@ -30,30 +34,33 @@ services:
# Specifies the admin password for the service
- ADMIN_PASSWORD=casaos
- # Mount necessary volumes for accessing system information
+ # Volume mappings required for system integration
+ # These mounts allow the container to interact with the host system
volumes:
- # Mounting the cgroup filesystem in read-only mode for system resource monitoring
+ # Required for monitoring system resources and container metrics
- /sys/fs/cgroup:/sys/fs/cgroup:ro
- # Persisting CasaOS database files to retain data across container restarts
+ # Persistent storage for CasaOS database to maintain user data
- /var/lib/casaos/db:/var/lib/casaos/db
- # Mounting systemd's runtime directory for integration with the host system
+ # Access to systemd for service management and system integration
- /run/systemd/system:/run/systemd/system
- # Providing access to the D-Bus system bus for communication with host services
+ # D-Bus socket for system communication and service discovery
- /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket | _:hammer_and_wrench: Refactor suggestion_
**Enhance volume configuration for better security and data management**
Current volume mappings could be improved for better security and data management:
1. Consider using named volumes for database persistence
2. Add explicit read-only flags where appropriate
3. Document backup procedures for the database volume
Suggested improvements:
```diff
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:ro
- - /var/lib/casaos/db:/var/lib/casaos/db
+ - casaos_db_data:/var/lib/casaos/db
- /run/systemd/system:/run/systemd/system:ro
- /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket:ro
+ volumes:
+ casaos_db_data:
+ driver: local
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
# Volume mappings required for system integration
# These mounts allow the container to interact with the host system
volumes:
# Required for monitoring system resources and container metrics
- /sys/fs/cgroup:/sys/fs/cgroup:ro
# Persistent storage for CasaOS database to maintain user data
- casaos_db_data:/var/lib/casaos/db
# Access to systemd for service management and system integration
- /run/systemd/system:/run/systemd/system:ro
# D-Bus socket for system communication and service discovery
- /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket:ro
volumes:
casaos_db_data:
driver: local
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | dragonfire1119 | @@ -59,6 +59,7 @@ If you have a suggestion for an app, please post in the [BigBearCommunity](https
| dockge | louislam/dockge | 1.4.2 | [YouTube Video](https://youtu.be/8Z6psh-t5iU) | |
| docmost | docmost/docmost | 0.2.10 | | |
| dozzle | amir20/dozzle | 8.2.1 | [YouTube Video](https://youtu.be/lLLNDcHNOuM) | |
+| EJBCA Community | keyfactor/ejbca-ce | 8.3.2 | | | | There is no need for this modification. |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,86 @@
+# Configuration for ejbca-ce setup
+
+# Name of the big-bear-ejbca-ce application
+name: big-bear-ejbca-ce
+
+# Service definitions for the big-bear-ejbca-ce application
+services:
+ # Service name: app
+ # The `app` service definition
+ app: | Change this to `big-bear-ejbca-ce` |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,86 @@
+# Configuration for ejbca-ce setup
+
+# Name of the big-bear-ejbca-ce application
+name: big-bear-ejbca-ce
+
+# Service definitions for the big-bear-ejbca-ce application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-ejbca-ce:
+ # Name of the container
+ container_name: big-bear-ejbca-ce
+
+ # Image to be used for the container
+ image: keyfactor/ejbca-ce:8.3.2
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local ejbca-ce/persistent directory to /mnt/persistent inside the container
+ - /DATA/AppData/$AppID/persistent:/mnt/persistent
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 8080 of the host to port 8080 of the container
+ - "8080:8080"
+
+ # Mapping port 8443 of the host to port 8443 of the container
+ - "8443:8443"
+ | _:hammer_and_wrench: Refactor suggestion_
**Consider security implications of exposing HTTP port.**
Port 8080 (HTTP) is exposed alongside HTTPS. Since EJBCA handles sensitive PKI operations, consider:
1. Using only HTTPS (8443) for secure communication
2. If HTTP is required, restrict it to localhost or internal network
```diff
ports:
- # Mapping port 8080 of the host to port 8080 of the container
- - "8080:8080"
+ # Restrict HTTP to localhost if needed
+ - "127.0.0.1:8080:8080"
# Mapping port 8443 of the host to port 8443 of the container
- "8443:8443"
```
<!-- suggestion_start -->
<details>
<summary>π Committable suggestion</summary>
> βΌοΈ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
`````suggestion
ports:
# Restrict HTTP to localhost if needed
- "127.0.0.1:8080:8080"
# Mapping port 8443 of the host to port 8443 of the container
- "8443:8443"
`````
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | coderabbitai[bot] | @@ -0,0 +1,86 @@
+# Configuration for ejbca-ce setup
+
+# Name of the big-bear-ejbca-ce application
+name: big-bear-ejbca-ce
+
+# Service definitions for the big-bear-ejbca-ce application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-ejbca-ce:
+ # Name of the container
+ container_name: big-bear-ejbca-ce
+
+ # Image to be used for the container
+ image: keyfactor/ejbca-ce:8.3.2 | _:bulb: Codebase verification_
**Update the image reference to use SHA digest for immutability**
The version 8.3.2 is currently the latest available version, but for better security and immutability, update the image reference to include the SHA digest:
```yaml
image: keyfactor/ejbca-ce@sha256:2382758f0c56ae1bc97693c650ef21e725bd453282c7e57b82590028f99e3b06
```
<details>
<summary>π Analysis chain</summary>
**Verify the image version and consider using SHA digest.**
The current image tag `8.3.2` should be verified for being the latest stable version. Consider using SHA digest for immutable builds.
</details>
<details>
<summary>π Scripts executed</summary>
The following scripts were executed for the analysis:
Script:
```shell
#!/bin/bash
# Check latest version and digests
curl -s "https://registry.hub.docker.com/v2/repositories/keyfactor/ejbca-ce/tags?page_size=10" | jq -r '.results[] | select(.name | contains(".")) | {name: .name, digest: .digest}'
```
Length of output: 1107
</details>
<!-- This is an auto-generated comment by CodeRabbit --> |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,86 @@
+# Configuration for ejbca-ce setup
+
+# Name of the big-bear-ejbca-ce application
+name: big-bear-ejbca-ce
+
+# Service definitions for the big-bear-ejbca-ce application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-ejbca-ce:
+ # Name of the container
+ container_name: big-bear-ejbca-ce
+
+ # Image to be used for the container
+ image: keyfactor/ejbca-ce:8.3.2
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local ejbca-ce/persistent directory to /mnt/persistent inside the container
+ - /DATA/AppData/$AppID/persistent:/mnt/persistent
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 8080 of the host to port 8080 of the container
+ - "8080:8080"
+
+ # Mapping port 8443 of the host to port 8443 of the container
+ - "8443:8443"
+
+ # Environment variables
+ environment:
+ - TLS_SETUP_ENABLED=simple
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+
+ # Main service of the application
+ main: app | Change app to: big-bear-ejbca-ce |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,86 @@
+# Configuration for ejbca-ce setup
+
+# Name of the big-bear-ejbca-ce application
+name: big-bear-ejbca-ce
+
+# Service definitions for the big-bear-ejbca-ce application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-ejbca-ce:
+ # Name of the container
+ container_name: big-bear-ejbca-ce
+
+ # Image to be used for the container
+ image: keyfactor/ejbca-ce:8.3.2
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local ejbca-ce/persistent directory to /mnt/persistent inside the container
+ - /DATA/AppData/$AppID/persistent:/mnt/persistent
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 8080 of the host to port 8080 of the container
+ - "8080:8080"
+
+ # Mapping port 8443 of the host to port 8443 of the container
+ - "8443:8443"
+
+ # Environment variables
+ environment:
+ - TLS_SETUP_ENABLED=simple
+
+# CasaOS specific configuration
+x-casaos:
+ # Supported CPU architectures for the application
+ architectures:
+ - amd64
+
+ # Main service of the application
+ main: big-bear-ejbca-ce
+
+ description:
+ # Description in English
+ en_us: The open-source public key infrastructure (PKI) and certificate authority (CA) software EJBCA is one of the longest running CA software projects. EJBCA covers all your needs - from certificate enrollment, via certificate management, to certificate validation.
+
+ tagline:
+ # Short description or tagline in English
+ en_us: The open-source public key infrastructure (PKI) and certificate authority (CA)
+
+ # Developer's name or identifier
+ developer: "Keyfactor"
+
+ # Author of this configuration
+ author: BigBearCommunity
+
+ # Icon for the application
+ icon: https://raw.githubusercontent.com/Keyfactor/ejbca-ce/main/.github/images/community-ejbca-icon.png | This needs to be changed to: ```https://cdn.jsdelivr.net/gh/Keyfactor/ejbca-ce/.github/images/community-ejbca-icon.png``` because Github has a rate limit. |
big-bear-casaos | github_2023 | others | 1,207 | bigbeartechworld | dragonfire1119 | @@ -0,0 +1,86 @@
+# Configuration for ejbca-ce setup
+
+# Name of the big-bear-ejbca-ce application
+name: big-bear-ejbca-ce
+
+# Service definitions for the big-bear-ejbca-ce application
+services:
+ # Service name: app
+ # The `app` service definition
+ big-bear-ejbca-ce:
+ # Name of the container
+ container_name: big-bear-ejbca-ce
+
+ # Image to be used for the container
+ image: keyfactor/ejbca-ce:8.3.2
+
+ # Container restart policy
+ restart: unless-stopped
+
+ # Volumes to be mounted to the container
+ volumes:
+ # Mounting the local ejbca-ce/persistent directory to /mnt/persistent inside the container
+ - /DATA/AppData/$AppID/persistent:/mnt/persistent
+
+ # Ports mapping between host and container
+ ports:
+ # Mapping port 8080 of the host to port 8080 of the container
+ - "8080:8080"
+
+ # Mapping port 8443 of the host to port 8443 of the container
+ - "8443:8443"
+
+ # Environment variables
+ environment:
+ - TLS_SETUP_ENABLED=simple
+ | The x-casaos info to explain volumes, envs, and ports. Example: https://github.com/bigbeartechworld/big-bear-casaos/blob/83bd5bdc50dbdd72935436d430f9a9b95f1216a4/Apps/baserow/docker-compose.yml#L28 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.