Merge pull request #2709 from chaoss/main

Dev updated from Main following Action Changes for Baseline

.github/workflows/auto_merge.yml

@@ -0,0 +1,22 @@
+name: Merge main into dev
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update-dev:
+    permissions: write-all
+    name: update-dev
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          git checkout dev
+          git merge main
+      - name: Push to dev
+        uses: CasperWA/push-protected@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: dev

docs/new-install.md

@@ -374,3 +374,5 @@ You can stop augur with `augur backend stop`, followed by `augur backend kill`.
 4. `sudo docker build -t augur-new -f docker/backend/Dockerfile .`
 5. `sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to run the database in a Docker Container or 
    `sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to connect to an already running database. 
+
+_Note: `AUGUR\_DB` and `RABBIT\_*` variables are optional when using the default docker-comopse.yml. `docker-compose-externalDB` does require `AUGUR\_DB` set to a postgresql installation._

docs/source/docker/usage.rst

@@ -43,33 +43,6 @@ By default, the only logs shown by the container are the logs of Augur's main da
 
 As for worker logs. They are currently a work in progress to be made easier to view. Shortly, they will automatically populate on the host machine and it will not be necessary to step inside the container.
 
-Using the repo loading UI [NOT RECOMMENDED]
--------------------------------------------
-
-.. warning::
-    The frontend is very out of date and will *very likely* not work with the backend. It is still available,however. The recommended way of accessing augur through docker is through standard api calls at ``localhost:5000``.
-
-
-Augur offers a special graphical interface for loading repository groups when using the Docker containers. This component is called ``augurface``, and is available anytime you are using the ``backend`` and ``frontend`` services together.
-
-To use it first, start the two services (we recommend using `Docker Compose Script <docker-compose.html>`_ for this):
-
-.. code-block:: bash
-
-    # this example uses the docker-setup script
-    $ sudo ./docker-setup.sh
-
-Then, navigate to ``http://localhost:8080/augurface/`` in your browser - **note the trailing slash!** Once you're on this page, you'll need to enter your Augur API key in the box on the top right. On a default Docker installation, you can use ``docker_key``, but we recommend changing this as soon as possible if you are planning to use the instance long-term. Commands for working with the API keys can be found `here <../getting-started/command-line-interface/db.html>`_.
-
-Once you've entered your API key, you will be able to use the UI to automatically import GitHub organizations as a repo group, or manually create and edit repo groups yourself. Deleting repos or repo groups is are currently supported, but would be a great contribution!
-
-.. warning::
-
-    Because the UI only requires an API key to edit the database, **we recommend that you do not publicly deploy any Docker instance outside your local network or intranet.** The Docker build is intended ONLY for short-term data collection usage and local development. We understand if this inconveniences you, but the functionality is very new to Augur and still needs time to be production-ready. **You have been warned.**
-
-If are not using the ``frontend`` service, you can use the `database CLI <../getting-started/command-line-interface/db.html>`_ from within the container to add repos. See below for how to start a shell within the container.
-
-
 
 Conclusion
 -----------

environment.txt

@@ -3,4 +3,5 @@ AUGUR_GITHUB_USERNAME=<PUT YOUR GITHUB USERNAME HERE>
 AUGUR_GITLAB_API_KEY=<PUT YOUR GITLAB KEY HERE>
 AUGUR_GITLAB_USERNAME=<PUT YOUR GITLAB USERNAME HERE>
 AUGUR_DB=<PUT YOUR DATABASE CONNECTION STRING HERE>
-
+AUGUR_RABBITMQ_USERNAME=<OPTIONAL - SET DESIRED RABBITMQ USER>
+AUGUR_RABBITMQ_PASSWORD=<OPTIONAL - SET DESIRED RABBITMQ PASSWORD>