Local CI and local VC setup
This section describes how to set up a programming exercise environment based on the local CI and local VC systems. These two systems are integrated into the Artemis server application and thus the setup is greatly simplified compared to the external options. This also reduces system requirements as you do not have to run any systems in addition to the Artemis server. For now, this setup is only recommended for development and testing purposes. If you are setting Artemis up for the first time, these are the steps you should follow:
Install and run Docker: https://docs.docker.com/get-docker
Start the database: Database Setup
(optional) Configure Jira
You can see the configuration in the following video:
Create a file
src/main/resources/config/application-local.yml with the following content:
artemis: user-management: use-external: false # if you do not wish to use Jira for user management version-control: url: http://localhost:8080
The values configured here are sufficient for a basic Artemis setup that allows for running programming exercises with the local VC and local CI systems.
If you are running Artemis in Windows, you also need to add a property
artemis.continuous-integration.docker-connection-uri with the value
The default value for this property is
unix:///var/run/docker.sock which is defined in
application-local.yml file overrides the values set there. When using Windows, you will also need make sure to enable the Docker setting “Expose daemon on tcp://localhost:2375 without TLS”. You can do this in Docker Desktop under Settings > General.
When you start Artemis for the first time, it will automatically create an admin user called “artemis_admin”. If this does not work, refer to the guide for the Jenkins and GitLab Setup to manually create an admin user in the database. You can then use that admin user to create further users in Artemis’ internal user management system.
The local CI and local VC systems work fine without external user management configured so this step is optional. Setting up Jira allows you to run a script that sets up a number of users and groups for you.
If you have already set up your system with Bamboo, Bitbucket, and Jira, you can keep using Jira for user management. Just stop the Bamboo and Bitbucket containers. If you want to use Jira for user management, but have not configured it yet, refer to the guide for the Bamboo, Bitbucket and Jira Setup. You can follow all steps to set up the entire Atlassian stack, or just get the license for Jira and only follow steps 1-3 leaving out the setup of the Bamboo and Bitbucket containers. You can stop and remove the Bamboo and Bitbucket containers or just stop them in case you want to set them up later on.
You also need to configure further settings in the
artemis: user-management: use-external: true external: url: http://localhost:8081 user: <jira-admin-user> # insert the admin user you created in Jira password: <jira-admin-password> # insert the admin user's password admin-group-name: instructors
Start Artemis with the profiles
localvc so that the correct adapters will be used,
All of these profiles are enabled by default when using the
Artemis (Server, LocalVC & LocalCI) run configuration in IntelliJ.
jira to the list of profiles if you want to use Jira for user management: dev,localci,localvc,artemis,scheduling,local,jira
Please read Server Setup for more details.
You can now test the setup:
To create a course with registered users, you can use the scripts from
Create a course and a programming exercise.
Log in as a student registered for that course and participate in the programming exercise, either from the online editor or by cloning the repository and pushing from your local environment.
Make sure that the result of your submission is displayed in the Artemis UI.
At the moment, the local VC system only supports accessing repositories via HTTP(S) and Basic Auth. We plan to add SSH support in the future. For now, you need to enter your Artemis credentials (username and password) when accessing template, solution, test, and assignment repositories.
For unauthorized access, your Git client will display the respective error message:
You can also use Docker Compose to set up the local CI and local VC systems. Using the following command, you can start the Artemis and MySQL containers:
docker compose -f docker/artemis-dev-local-vc-local-ci-mysql.yml up
Unix systems: When running the Artemis container on a Unix system, you will have to give the user running the container permission to access the Docker socket by adding them to the
docker group. You can do this by changing the value of
services.artemis-app.group_add in the
docker/artemis-dev-local-vc-local-ci-mysql.yml file to the group ID of the
docker group on your system. You can find the group ID by running
getent group docker | cut -d: -f3. The default value is
Windows: If you want to run the Docker containers locally on Windows, you will have to change the value for the Docker connection URI. You can add
ARTEMIS_CONTINUOUSINTEGRATION_DOCKERCONNECTIONURI="tcp://host.docker.internal:2375" to the environment file, found in
docker/artemis/config/dev-local-vc-local-ci.env. This overwrites the default value
unix:///var/run/docker.sock for this property defined in