diff --git a/.env.example b/.env.example index cae0061..e864cae 100644 --- a/.env.example +++ b/.env.example @@ -29,6 +29,9 @@ ADMIN_EMAIL=admin@example.com # If the location data is stored on another db than the one used by the backend, # you can specify a different database URL here. +# Note that the data integrity over insertion/deletion is not guaranteed if you +# use a separate database for the location data. This should be mostly used for +# read-only access or for testing purposes. # DB_LOCATION_URL=postgres://user:password@host:port/dbname # Database dialect (default: inferred from the URL) @@ -39,49 +42,51 @@ ADMIN_EMAIL=admin@example.com # Prefix for the application tables (default: empty). # Note that this does not apply to DB_LOCATION_TABLE if it is set. -DB_TABLE_PREFIX= +# DB_TABLE_PREFIX= -# Name of the table that contains the location points (required) -DB_LOCATION_TABLE=location_history +# Override the name of the table that contains the location points - mostly useful +# if you want to use a different database for the location data. +# DB_LOCATION_TABLE=location_history -## Database mappings +## Database mappings - mostly useful if you want to use a different database for the location data # The name of the column that contains the primary key of each location point -DB_LOCATION__ID=id +# DB_LOCATION__ID=id # The name of the column that contains the device ID of each location point -DB_LOCATION__DEVICE_ID=deviceId +# DB_LOCATION__DEVICE_ID=deviceId # The name of the column that contains the timestamp of each location point -DB_LOCATION__TIMESTAMP=timestamp +# DB_LOCATION__TIMESTAMP=timestamp # The name of the column that contains the latitude of each location point -DB_LOCATION__LATITUDE=latitude +# DB_LOCATION__LATITUDE=latitude # The name of the column that contains the longitude of each location point -DB_LOCATION__LONGITUDE=longitude +# DB_LOCATION__LONGITUDE=longitude # The name of the column that contains the altitude of each location point. # Comment or leave empty if the altitude is not available. -DB_LOCATION__ALTITUDE=altitude +# DB_LOCATION__ALTITUDE=altitude # The name of the column that contains the address of each location point. # Comment or leave empty if the address is not available. -DB_LOCATION__ADDRESS=address +# DB_LOCATION__ADDRESS=address # The name of the column that contains the city/locality name of each location point # Comment or leave empty if the locality is not available. -DB_LOCATION__LOCALITY=locality +# DB_LOCATION__LOCALITY=locality # The name of the column that contains the country code of each location point # Comment or leave empty if the country code is not available. -DB_LOCATION__COUNTRY=country +# DB_LOCATION__COUNTRY=country # The name of the column that contains the postal code of each location point # Comment or leave empty if the postal code is not available. -DB_LOCATION__POSTAL_CODE=postalCode +# DB_LOCATION__POSTAL_CODE=postalCode ### -### Frontend configuration +### Frontend configuration. +### This is only required if you want to run the frontend in development mode ### VITE_API_BASE_URL=http://localhost:${BACKEND_PORT}