Usage

This chapter describes smartlog-client and smartlog-installer usage, as well as some common problems and solutions.

Access Smartlog API

Smartlog API is accessible on server port 8080. Smartlog client utilizes Swagger, you can browse and test it via web browser. Currently there's no authentication so make sure to limit access to the port.

Passing arguments to installer script

If you need to pass arguments to peers docker run command, you can do so with environment variable PEER_EXTRA_ARGS. All commands that docker run understands, can be used.

Here's an example where we map somedomain.com to IP:

$ curl -s "https://projectsmartlog.gitlab.io/smartlog-installer/smartlog-installer.sh" | sudo PEER_EXTRA_ARGS="--add-host somedomain.com:10.0.0.132" bash

Setting Smartlog environment up manually

You should never run anything blindly on your server, so perhaps you would like to install Smartlog manually? Installer script is very straightforward and easy to follow. In practice, installer stops and removes previous versions, removes smartlog docker network, pulls latest images and starts them with certain required arguments. Perhaps the most important ones are CouchDB credentials and bind mounts. If you want deeper understanding about what is what, take a look at Overview.

Cloud version usage

Cloud version of the client can be found from url https://cloud.projectsmartlog.com. You need client certificate that we have generated for your organization to access the site. Instructions how to add your client certificate:

Windows:

Import client certificate using the Certificate Import Wizard. Double click the "store.p12"-file that is in the organization zip and Certificate Import Wizard should open.

  1. On the first page, it asks you on what store location you want to import the certificate, select "Current User".
  2. On the "File to import" page, click next.
  3. On the "Private key protection" page, type the keystore-password that can be found from "credentials.txt" file that is in organization zip.
  4. On the "Certificate Store" page, select "Place all certificates in the following store" and click "Browse". Select "Personal" folder and click "ok"
  5. On the final page, just press "Finish".

Import certificate to Firefox

  1. Open Firefox and press the button with three lines in the top right corner
  2. Choose Options>Privacy & Security
  3. Scroll down to Certificates and click View Certificates
  4. Choose Your Certificates-tab and click Import
  5. Browse to the config folder that was sent to your organization, open crypto-config folder and choose the store.p12 file
  6. Type in the keystore-password that can be found in the credentials.txt file within the config folder

macOS:

  1. Double click the "store.p12" and and it should ask for the keystore-password, write the password that can be found from "credentials.txt" file that is in organization zip, and then the certificate is imported.

Now when the certificate is imported and you try to access the https://cloud.projectsmartlog.com your browser should ask what certificate you want to use. Select the certificate and click "OK" and it should ask you for credentials. You can find your credentials from the file "credentials.txt" in organization zip.

Credentials are needed if you want to access UBL-API documentation or console where you can read messages that are for your organization. Console can be accessed via url https://cloud.projectsmartlog.com/console

Making requests to UBL API's

You need to provide the client certificate in the request, otherwise the connection to API's can't be established. Certificate and key can be found from the "crypto-config" folder and those are named client.key and client.crt

results matching ""

    No results matching ""