TdLM is a back-end service developed as part of truedat project that supports the management of objects linkage between services
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Install dependencies with mix deps.get
To start your Phoenix server:
-
Create and migrate your database with
mix ecto.create && mix ecto.migrate -
Start Phoenix endpoint with
mix phx.server -
Now you can visit
localhost:4012from your browser.
Run all aplication tests with mix test
REDIS_AUDIT_STREAM_MAXLEN(Optional) Maximum length for Redis audit stream. Default: 100REDIS_STREAM_MAXLEN(Optional) Maximum length for Redis stream. Default: 100REDIS_CACHE_TIMEOUT(Optional) environment variable configures the timeout (in milliseconds) for Redis cache operations, preventing indefinite waits during bulk link creation. Default value is 120000 (2 minutes)
- DB_SSL: boolean value, to enable TSL config, by default is false.
- DB_SSL_CACERTFILE: path of the certification authority cert file "/path/to/ca.crt".
- DB_SSL_VERSION: available versions are tlsv1.2, tlsv1.3 by default is tlsv1.2.
- DB_SSL_CLIENT_CERT: Path to the client SSL certificate file.
- DB_SSL_CLIENT_KEY: Path to the client SSL private key file.
- DB_SSL_VERIFY: This option specifies whether certificates are to be verified.
- The aggregation variables are defined as follows: AGG_<AGGREGATION_NAME>_SIZE
These environment variables will add the Authentication header on each request
with value Basic <ES_USERNAME>:<ES_PASSWORD>
- ES_USERNAME: Username
- ES_PASSWORD: Password
This environment variables will add the Authentication header on each request
with value ApiKey <ES_API_KEY>
- ES_API_KEY: ApiKey
These environment variables will configure CA Certificates for HTTPS requests
- ES_SSL: [true | false] required to activate following options
- ES_SSL_CACERTFILE: (Optional) Indicate the cacert file path. If not set, a certfile will be automatically generated by
:certifi.cacertfile() - ES_SSL_VERIFY: (Optional) [verify_peer | verify_none] defaults to
verify_none
These environment variables control the force merge operation for ElasticSearch indices, which optimizes index performance by merging segments.
-
ES_WAIT_FOR_COMPLETION:- Purpose: Controls whether the force merge operation should wait for completion before returning
- Default:
nil(no wait) - Usage: When set to
true, the operation will wait until the force merge is complete before returning. Whenfalseornil, the operation returns immediately and runs asynchronously - Performance: Setting to
trueensures the operation is complete but may cause longer response times
-
ES_MAX_NUM_SEGMENTS:- Purpose: Specifies the maximum number of segments to merge down to
- Default:
5 - Usage: Controls how aggressively the force merge operation consolidates segments. Lower values result in fewer, larger segments
- Performance: Fewer segments generally improve search performance but may increase memory usage during the merge operation
-
OBAN_DB_SCHEMA: Purpose: Defines the database schema where Oban will create its tables Default value: "private" Usage: Configures the schema prefix for Oban tables (jobs, peers, etc.) Example: If set to "oban_schema", tables will be created in the schema oban_schema.jobs, oban_schema.peers, etc.
-
OBAN_CREATE_SCHEMA: Purpose: Controls whether Oban should automatically create the database schema Default value: "true" Usage: Determines if the Oban migration should create the schema specified in OBAN_DB_SCHEMA Valid values: "true": Automatically creates the schema "false": Does not create the schema (must exist beforehand)
-
OBAN_FILE_ATTEMPTS Purpose: Define how many attempts Oban may try to process the file Default value: 5 Valid values: positive integers
Ready to run in production? Please check deployment guides.
- Phoenix - Web framework
- Ecto - Phoenix and Ecto integration
- Postgrex - PostgreSQL driver for Elixir
- Cowboy - HTTP server for Erlang/OTP
- httpoison - HTTP client for Elixir
- credo - Static code analysis tool for the Elixir language
- guardian - Authentication library
- canada - Permission definitions in Elixir apps
- ex_machina - Create test data for Elixir applications
- ex_json_schema - Elixir JSON Schema validator
- json_diff - Elixir JSON Schema validator
- corsica - Elixir library for dealing with CORS requests.
- Bluetab Solutions Group, SL - Initial work - Bluetab
See also the list of contributors who participated in this project.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
In order to use this software, it is necessary that, depending on the type of functionality that you want to obtain, it is assembled with other software whose license may be governed by other terms different than the GNU General Public License version 3 or later. In that case, it will be absolutely necessary that, in order to make a correct use of the software to be assembled, you give compliance with the rules of the concrete license (of Free Software or Open Source Software) of use in each case, as well as, where appropriate, obtaining of the permits that are necessary for these appropriate purposes.