Platform startup

Passing arguments to the platform

The platform can be run in two ways. Passing arguments to it is done differently depending on which method you are using:

Using Docker

The Docker image is configured with an ENTRYPOINT so any arguments passed after specifying the image are passed directly to the platform.

Example:

docker run -d --name carbonldp-platform -p 8083:8083 carbonldp/carbonldp-platform:5.0.0 --specify-arguments="here"

Specifying java options

Java options can be specified by setting the environment variable JAVA_OPTS when running the container.

Example:

docker run -d --name carbonldp-platform -p 8083:8083 \
	-e JAVA_OPTS="-Xms1g -Xmx2g" \                      # -e tells Docker to set an environment variable
	carbonldp/carbonldp-platform:5.0.0

Executing the jar

If you are running the platform directly from the jar, passing the arguments is done the same way as with any other jar.

Example:

java -jar carbonldp-platform.jar --specify-arguments here

Arguments reference

The main arguments to specify on startup are the ones related to how the instance will be exposed to the public. This is needed since the platform uses this information for its URIs (e.g. if it is going to be exposed in http://example.org/ all the URIs will start with this base).

Argument Default Description
--server.exposed.ssl false Whether or not the server will be exposed through https
--server.exposed.host localhost Host where the server will be exposed
--server.exposed.port 8083 Port exposed to the public on where the platform listens for connections

For a complete list please refer to the next section: Platform configuration

License configuration

The platform can be executed using two different license configurations, Standard and Enterprise.

Standard

To run the platform’s Standard edition, no license needs to be specified. Instead, only contact information needs to be provided through the configuration properties:

Property Type Description
--carbonldp.contact.name String User’s contact name
--carbonldp.contact.email String User’s contact email
--carbonldp.contact.company String User’s company name

Enterprise

After purchasing an Enterprise license, you should have received the file license.key with similar contents to:

-----BEGIN CARBON LDP LICENSE-----
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
-----END CARBON LDP LICENSE-----

This license can be provided to platform instances through the following options:

  • As a file inside the platform’s working directory (e.g. /your/directory/path/carbonldp/license.key)
    Note: When using Docker, the working directory is the same as the directory used for the container’s volume.
  • By specifying a file through the carbonldp.license property. Example:
    java -jar carbonldp-platform.jar \
    	--carbonldp.license="/some/directory/license.key"
    
  • By providing the license key directly through the carbonldp.license property. Example:
    docker run -d --name carbonldp-platform -p 8083:8083 \
    	carbonldp/carbonldp-platform:5 \
    		--carbonldp.license="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    

    Note: The license key is the content between

    -----BEGIN CARBON LDP LICENSE-----

    and

    -----END CARBON LDP LICENSE-----