Author: Windmüller
Publication Date: 9/20/2024 14:52
This article describes the usage of the FirstSpirit Docker image. The image allows for starting FirstSpirit easily in an arbitrary version. It is designed primarily for developers who want to test their modules or develop FirstSpirit projects locally and should not be used in a productive environment. Apart from Docker, there are no requirements to the host system like an installed Java version.
The image setup adheres to the official installation instructions, thus providing a FirstSpirit server installed according to the best practice. It behaves like any other Docker image, for example it only starts FirstSpirit: a Tomcat web-server has to be attached with a second container.
System Requirements
On the host system a configured Docker installation is required that is ready to run containers. This varies depending on the operating system, instructions for Linux, MacOS and Windows are available.
You can test your Docker setup with the Hello World image:
$ docker run hello-worldStarting the Container
In the most simple case, start the image in the favoured version:
$ docker run --rm -p8000:8000 docker.artifactory.e-spirit.hosting/e-spirit/firstspirit:5.2.241009If you receive an error that the image could not be found, you might need to authenticate first:
$ docker login docker.artifactory.e-spirit.hostingIn order to stop the server, press Ctrl+C on the terminal used to start the container.
Persisting Configuration and Data
If no volume has been defined, the image will use an anonymous volume for the FirstSpirit directory. It is possible to define a dedicated volume or a bind mount instead.
Creating a volume is done with the command
$ docker volume create firstspirit
$ docker run --rm -p8000:8000 \
-v firstspirit:/opt/firstspirit5 \
docker.artifactory.e-spirit.hosting/e-spirit/firstspirit:5.2.241009
If the persistence should be performed on the host system, the container may be started with a bind mount instead:
docker run --rm -p8000:8000 \
-v /home/user/data/fs:/opt/firstspirit5 \
docker.artifactory.e-spirit.hosting/e-spirit/firstspirit:5.2.241009
Frequently Asked Questions
How can I Configure a Debug Port for the FirstSpirit Server?
After persisting the configuration (see above) edit the file "conf/fs-wrapper-isolated.conf":
wrapper.java.additional.9=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005
docker run --rm -p8000:8000 -p5005:5005 [...]
The server should contain pre-installed modules. How can that be accomplished?
Installing a module using ServerManager may be a repetitive task slowing down the development cycle. In order to place the module in the FirstSpirit server automatically, there are two different ways:
- Before the server is started, place the FSM file in the "data/modules" directory
- After the server is started, use fs-cli to install the FSM:
$ fs-cli.sh module install --fsm dev.fsm
Please note that fs-cli requires a valid license installed for the FirstSpirit server.
How can I import a project programmatically?
Other than modules, FirstSpirit projects can only be installed once the server is up and running. The easiest way is using fs-cli:
$ fs-cli.sh project import --importProjectName Mithras --projectFile mithras-energy.tar.gz
Kommentare
8 Kommentare
HI ,
is there a possibility to change the port number, so we are able to have multiple containers running in parallel? This is a must have requirement for developers.
I encountered some problems when just changing the mapped host port number to e.g. 8001. It seems that then the preview is not working correct because the generated preview URLs are still generated with port number 8000. Can you confirm this?
Also will the docker / compose files be available on Github, so that the community can extend and improve it?
Greetings
Sandro
Hello ,
as mentioned in the section "Persisting Configuration and Data" it is possible to configure any setting, including the port number.
The Docker file contains nothing fancy, it just extracts the installer, places the server jar at the right location and configures the entry script. Therefore I am not sure if publishing this would help anyone.
I noticed that you rated the article 4/5. What is missing in your opinion?
Best Regards
Stephan
Great article,
Just a little comment, I've played around with this and I found that I need to have a license to use the fs-cli in the docker image, is it true?
Best regards
Yes, the fs-cli tool requires a valid license on the server.
thanks for your reply.
As I said, testing this implementation was really great, but I think asking for an additional license is way too much (this should be included at least with the cloud license).
Maybe it's something to have in mind in the future.
A cloud license includes licenses for developers which can be used with a FirstSpirit server regardless if it runs in a Docker image or not.
thanks a lot for the response... so, we should use the same license we have for the Cloud in the Docker image and it could solve this problem, correct?
I was not aware of the license in the cloud, I guess it's enough to create a ticket support requesting these licenses to be used in the docker onprem image, right?
Just to be clear, we are not talking about the actual license used for the cloud servers. Instead, you are entitled to separate licenses for local development. Those can be requested at the Customer Support.
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.