lobometalurgico/arunacore

By lobometalurgico

Updated 8 months ago

The official ArunaCore image

Image
Networking
Integration & delivery
Internet of things
0

1.3K

lobometalurgico/arunacore repository overview

ArunaCore Docker Image

The official ArunaCore Docker image repository.

Source code for the ArunaCore project can be found at https://github.com/ArunaBot/ArunaCore


ArunaCore is an open-source websocket server for intercommunication between applications, distributed as a Docker image in two variants:

TagBase imageDescription
latestnode:jod-slimStandard version based on Debian
alpinenode:jod-alpineLightweight version based on Alpine Linux

How to use

Run the standard (slim) version
docker run -p 3000:3000 lobometalurgico/arunacore:latest
Run the Alpine version (smaller image)
docker run -p 3000:3000 lobometalurgico/arunacore:alpine

Version tags

You can also pull specific ArunaCore versions:

docker pull lobometalurgico/arunacore:1.0.0-BETA.3
docker pull lobometalurgico/arunacore:1.0.0-BETA.3-alpine

Port Configuration

The ArunaCore Docker container always listens on port 3000 internally. This port is fixed and cannot be changed via environment variables inside the container.

To expose ArunaCore on a different port on your host machine, use Docker's port mapping feature. For example, to expose the service on port 8080 externally, run:

docker run -p 8080:3000 lobometalurgico/arunacore

In this example, the container still listens on port 3000 internally, but the host forwards traffic from port 8080 to the container's port 3000.

Note: The healthcheck endpoint also uses port 3000 internally and expects the service to be available there.


Environment Variables

You can configure ArunaCore using environment variables by prefixing the configuration keys with ARUNACORE_ and capitalizing them. For nested properties, use underscores (_). For example, to override port, set ARUNACORE_PORT.

Configuration KeyEnvironment VariableDescriptionDefault
idARUNACORE_IDService identifierarunacore
debugARUNACORE_DEBUGEnable debug modefalse
portARUNACORE_PORTService listening port (ignored inside container, always 3000)3000
autoLogEndARUNACORE_AUTOLOGENDEnable automatic logging on process endtrue
masterkeyARUNACORE_MASTERKEYMaster key for privileged operations. If set to changeme (default), it will be ignored, disabling all functions that require it and showing a warning.changeme (ignored)
requireAuthARUNACORE_REQUIREAUTHRequire authenticationfalse
logger.coloredBackgroundARUNACORE_LOGGER_COLOREDBACKGROUNDEnable colored background in logger outputfalse
logger.allLineColoredARUNACORE_LOGGER_ALLLINECOLOREDEnable coloring of entire log linestrue

Usage Examples

Run with custom port and debug enabled (note: ARUNACORE_PORT will be ignored inside the container, the port should be mapped with Docker):

docker run -p 8080:3000 -e ARUNACORE_DEBUG=true lobometalurgico/arunacore

Run with master key set (remember to use a strong key!):

docker run -e ARUNACORE_MASTERKEY=yourStrongMasterKey lobometalurgico/arunacore

Disable authentication:

docker run -e ARUNACORE_REQUIREAUTH=false lobometalurgico/arunacore

Support and bugs

Report issues on GitHub:
https://github.com/ArunaBot/ArunaCore/issues


License

GPL-3.0


Maintained by LoboMetalurgico
Contact: [email protected]

Tag summary

Content type

Image

Digest

sha256:df5d419b2

Size

101.5 MB

Last updated

8 months ago

docker pull lobometalurgico/arunacore:v1.0.0-BETA.5