Page MenuHomeDevCentral
Files F3766616

No OneTemporary
Actions

View Options

diff --git a/README.md b/README.md
index 247c68d..43acf43 100644
--- a/README.md
+++ b/README.md
@@ -1,53 +1,53 @@
# Servers log microservice
Collects servers log entries and publish them as JSON
## Status
This is a work in progress, currently developed.
It's currently only suitable for the initial development.
## Run the service
The service can be configured
through the following environment variables:
* BIND — the address the HTTP server should listen to,
as a `ìp:port` expression (default: 0.0.0.0:3000)
* RUST_LOG — the level of logging,
`ìnfo` is recommended to get events stream (no default)
* STORE — the path to the SQLite database file
to store log (default: ./log.db)
## Build instructions
### Dependencies
To compile the service, you need:
* Rust (we use the nightly distribution channel)
* Cargo
* SQLite 3 (we link against it, so the .so is required)
### Compile
Use `cargo build` to compile and link the debug version.
-For the release, use `cargo build --release`.
+For the release, use `make` or `cargo build --release`.
### Bypass Cargo
If you bypass Cargo to compile, define the following
environment variables:
* CARGO_PKG_NAME
* CARGO_PKG_VERSION
### Tests
-To run the tests, use `cargo test`.
+To run the tests, use `make test`.
Note this is an executable, not a library.
As such, if you want to add a test, you can't use a tests/ folder:
the independent test crate won't be able to import the crate.
diff --git a/sql/README b/sql/README
index ec48b1b..27cba1e 100644
--- a/sql/README
+++ b/sql/README
@@ -1,6 +1,6 @@
This directory contains SQL schemas.
The source code includes schema.sql as compilation time,
-and so this golder is required to build.
+and so this folder is required to build.
The service uses SQLite.

File Metadata

Mime Type
text/x-diff
Expires
Sun, Nov 24, 19:18 (3 h, 35 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2258740
Default Alt Text
(1 KB)

Event Timeline

Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator