Merge pull request 'Mettre à jour documentation et examples' (#50) from docs/update-example into main

Reviewed-on: #50
This commit is contained in:
Victor Lacasse-Beaudoin 2023-04-28 19:10:20 -05:00
commit caaafe73cb
3 changed files with 62 additions and 7 deletions

View file

@ -51,9 +51,12 @@ func init() {
serverCmd.Flags().Int("server-port", 8080, "Port to run the webserver on (config: server.port)") serverCmd.Flags().Int("server-port", 8080, "Port to run the webserver on (config: server.port)")
viper.BindPFlag("server.port", serverCmd.Flags().Lookup("server-port")) viper.BindPFlag("server.port", serverCmd.Flags().Lookup("server-port"))
// server.documents.location - --server-documents-location // Not currently used
serverCmd.Flags().String("server-documents-location", "us-east", "Storage bucket location (config: server.documents.location)") /*
viper.BindPFlag("server.documents.location", serverCmd.Flags().Lookup("server-documents-location")) // server.documents.location - --server-documents-location
serverCmd.Flags().String("server-documents-location", "us-east", "Storage bucket location (config: server.documents.location)")
viper.BindPFlag("server.documents.location", serverCmd.Flags().Lookup("server-documents-location"))
*/
// server.documents.endpoint - --server-documents-endpoint // server.documents.endpoint - --server-documents-endpoint
serverCmd.Flags().String("server-documents-endpoint", "minio:9000", "Storage server endpoint (config: server.documents.endpoint)") serverCmd.Flags().String("server-documents-endpoint", "minio:9000", "Storage server endpoint (config: server.documents.endpoint)")
@ -87,11 +90,11 @@ func init() {
serverCmd.Flags().Bool("server-admin-auth", false, "Enable to allow basic authentication for /admin routes (config: server.admin.auth)") serverCmd.Flags().Bool("server-admin-auth", false, "Enable to allow basic authentication for /admin routes (config: server.admin.auth)")
viper.BindPFlag("server.admin.auth", serverCmd.Flags().Lookup("server-admin-auth")) viper.BindPFlag("server.admin.auth", serverCmd.Flags().Lookup("server-admin-auth"))
// server.admin.username - --server-frontend-username // server.admin.username - --server-admin-username
serverCmd.Flags().String("server-admin-username", "", "Username for basic authentication for /admin routes (config: server.admin.username)") serverCmd.Flags().String("server-admin-username", "", "Username for basic authentication for /admin routes (config: server.admin.username)")
viper.BindPFlag("server.admin.username", serverCmd.Flags().Lookup("server-admin-username")) viper.BindPFlag("server.admin.username", serverCmd.Flags().Lookup("server-admin-username"))
// server.admin.password - --server-frontend-password // server.admin.password - --server-admin-password
serverCmd.Flags().String("server-admin-password", "", "Password for basic authentication for /admin routes (config: server.admin.password)") serverCmd.Flags().String("server-admin-password", "", "Password for basic authentication for /admin routes (config: server.admin.password)")
viper.BindPFlag("server.admin.password", serverCmd.Flags().Lookup("server-admin-password")) viper.BindPFlag("server.admin.password", serverCmd.Flags().Lookup("server-admin-password"))
} }

View file

@ -12,7 +12,7 @@ services:
- 'minio' - 'minio'
restart: unless-stopped restart: unless-stopped
build: . build: .
image: agecem/agecem-org:latest image: git.agecem.com/agecem/agecem-org:latest
ports: ports:
- '8080:8080' - '8080:8080'
volumes: volumes:

View file

@ -1,14 +1,66 @@
# Server configuration
server: server:
# Port on which to run the webserver
#
# Currently only opens to all interfaces, and exposes the
# html and REST API routes on the same port.
port: 8080 port: 8080
documents: documents:
# Endpoint of the minio instance, without the protocol
#
# If deployed with docker-compose, specify minio's services.name
# (minio by default)
#
# If deployed elsewhere, specify minio's host ip or localhost if such is
# the case.
endpoint: 'minio:9000' endpoint: 'minio:9000'
# Turn on to specify that requests to minio should be done over https
#
# Recommended to be turned on if minio instance is exposed to a network
# that others have access to (i.e. not an isolated docker network)
use_ssl: false use_ssl: false
# Access credentials for minio instance.
#
# Can match either the initial credentials used during deployment of
# minio (.env for docker-compose) or credentials manually created in the minio instance.
#
# Change this to match your deployment
access_key_id: 'agecem-org' access_key_id: 'agecem-org'
secret_access_key: 'agecem-org' secret_access_key: 'agecem-org'
# Which buckets are allowed to be manipulated in the minio instance by the application.
#
# Also used to specify which buckets are to be created on receiving a POST request on /v1/seed
buckets: buckets:
- 'proces-verbaux' - 'proces-verbaux'
- 'politiques-et-reglements' - 'politiques-et-reglements'
api: api:
# necessary for production use # Enable or disable key auth on /v1 routes
#
# Recommended to be on in production
auth: true auth: true
# Key for authenticating to /v1 routes.
#
# Minimum 10 characters
#
# Change this in production
key: 'agecem-org' key: 'agecem-org'
admin:
# Enable or disable basic auth on /admin routes
#
# Recommended to be on in production
auth: true
# Username and password for authenticating to /admin routes
#
# Minimum 5 characters for username and 10 characters for password
#
# Change this in production
username: 'agecem-org'
password: 'agecem-org'