Deploy Firetomic

We both get credits for DigitalOcean if you end using their services so be a mate.

Or you could deploy to Heroku

Build Firetomic

clj -T:build uber builds an uberjar into the target/-directory.

Run Firetomic

Run firetomic in locally from the source:

clj -M:run

Or you could run the docker image like so:

docker run \
  --env FIRETOMIC_NAME=mydb \
  --env FIRETOMIC_FIREBASE_URL=https://project-id.firebaseio.com \
  --env FIRETOMIC_FIREBASE_AUTH \
  --env FIRETOMIC_PORT=4000 \
  --env FIRETOMIC_TOKEN=foshizzle \
  --env FIRETOMIC_AUTO_LOAD=true \
  --env FIRETOMIC_DEV_MODE=true \
  -p 4000:4000 \
  alekcz/firetomic:latest

The command above will read your firebase service account credentials from the FIRETOMIC_FIREBASE_AUTH environment variable. If you prefer you could set the environment variables on you machine. If you leaving out the = and value iin the above command hey will be pulled from your environment and passed to the docker images as is the case with FIRETOMIC_FIREBASE_AUTH.

If you prefer not to connect to firebase at this point you can use the firebase CLI and run the emulator.

npm install -g firebase-tools@10.1.2
firebase emulators:start --only database

The emulator runs on http://localhost:9000 and doesn't require authentication. All data is discarded when the emulator is shut down. You can learn more about the firebase emulator at https://firebase.google.com/docs/emulator-suite

Configuring Firetomic

File Configuration

Firetomic loads configuration from resources/config.edn relative to the current directory. This file has a number of options and overwrites all other configuration given via environment or properties. Below you can find an example to configure both Datahike and the server.

{:databases [{:store {:backend :firebase}
              :schema-flexibility :read
              :keep-history? false
              :name "sessions"}
             {:store {:backend :firebase}
              :name "users"
              :keep-history? true
              :schema-flexibility :write}]
 :server {:port  3333
          :loglevel :info
          :firebase-url "https://project-id.firebaseio.com/firetomic" 
          :auto-load true
          :dev-mode false
          :token :securerandompassword}}

Configuration via Environment and Properties

Firetomic can also be configured via environment variables. Please take a look at the configuration of Datahike to get an overview of the number of possible configuration options regarding the database. To configure the server please see the options below. Like in Datahike they are read via the environ library by weavejester. Please provide the logging level without colon. Beware that a configuration file overwrites the values from environment and properties.

envvar	default
FIRETOMIC_PORT	4000
FIRETOMIC_LOG_LEVEL	warn
FIRETOMIC_AUTO_LOAD	false
FIRETOMIC_DEV_MODE	false
FIRETOMIC_TOKEN	--
FIRETOMIC_NAME	--
FIRETOMIC_FIREBASE_URL	http://localhost:9000
FIRETOMIC_FIREBASE_AUTH	--
FIRETOMIC_CACHE	100000

Authentication

You can authenticate to Firetomic with a token specified via configuration. Please then send the token within your request headers as authentication: token <yourtoken>. If you don't want to use authentication during development you can set dev-mode to true in your configuration and just omit the authentication-header. Please be aware that your Firetomic might be running publicly accessible and then your data might be read by anyone and the server might be misused if no authentication is active.

Logging

We are using the library taoensso.timbre by Peter Taoussanis to provide meaningful log messages. Please set the loglevel that you prefer via means of configuration below. The possible levels are sorted in order from least severe to most severe:

trace
debug
info
warn
error
fatal
report

Roadmap

Release 0.2.0

Release 0.3.0

Import/Export/Backup
Metrics
Subscribe to transactions
Implement query engine in client

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.