Aparência
Configurar o ambiente
Existem várias definições da aplicação que podem ser alteradas através de variáveis de configuração da edição Enterprise ou variáveis de configuração da edição comunitária. Alguns deles têm valores predefinidos e outros precisam de ser alterados, nomeadamente aqueles com campos obrigatórios (assinalados com ⭐️ abaixo).
Noções básicas sobre servidores
As variáveis assinaladas com um asterisco ⭐️ têm de ser alteradas para utilização em produção.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
MERGIN_BASE_URL⭐️ | cadeia de caracteres | URL de implementação onde Mergin Maps está alojado. | |
COLLECT_STATISTICS | Booleano | verdadeiro | Se pretende enviar estatísticas de utilização para melhorar a aplicação. Para mais informações, consulte esta secção da página. |
CONTACT_EMAIL | cadeia de caracteres | `` | Endereço de e-mail de contacto do administrador da aplicação. |
SERVICE_ID | cadeia de caracteres | UUID da implementação. Gerado automaticamente na primeira execução. | |
| |
Definições de segurança (importantes para utilização em ambiente de produção)🛡️
As definições de segurança são importantes para a utilização em ambiente de produção.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
VALIDADE_DO_TOKEN_AO_PORTADOR | número inteiro | 43200 | Tempo de validade do token de portador da autorização, em segundos. Quando expirar, os utilizadores terão de iniciar sessão novamente. |
SECRET_KEY⭐️ | cadeia de caracteres | A chave secreta para autorização deve ser uma cadeia de caracteres forte, gerada aleatoriamente. | |
SECURITY_EMAIL_SALT⭐️ | cadeia de caracteres | O «salt» do token para o envio do e-mail de verificação deve ser uma sequência de caracteres forte e gerada aleatoriamente. | |
SECURITY_BEARER_SALT⭐️ | cadeia de caracteres | Salt do token de portador para descodificar o token web; deve ser uma cadeia de caracteres forte gerada. | |
SECURITY_PASSWORD_SALT⭐️ | cadeia de caracteres | O «salt» da palavra-passe para o hash deve ser uma cadeia de caracteres forte e gerada aleatoriamente. | |
WTF_CSRF_ENABLED | Booleano | verdadeiro | Ative a proteção contra CSRF. É altamente recomendável que esta opção esteja ativada. |
WTF_CSRF_TIME_LIMIT | número inteiro | 86400 | Tempo de validade do token CSRF em segundos. Quando expirar, os utilizadores terão de o atualizar. |
| |
Definições da base de dados
Mergin Maps utiliza a base de dados PostgreSQL para armazenar os seus dados.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
DB_APPLICATION_NAME | cadeia de caracteres | fusão | Adicione um comentário à cadeia de ligação à base de dados para identificar melhor a origem da ligação. |
DB_DATABASE ⭐️ | cadeia de caracteres | postgres | Base de dados para armazenar Mergin Maps tabelas. |
DB_HOST | cadeia de caracteres | db | Servidor da base de dados. Associado ao nome do serviço no Docker Compose. |
DB_PASSWORD ⭐️ | cadeia de caracteres | postgres | Palavra-passe do utilizador do PostgreSQL. |
DB_PORT | número inteiro | 5432 | Porta da base de dados. Se não for a porta predefinida, deve corresponder à porta indicada no ficheiro docker-compose. |
DB_POOL_MAX_OVERFLOW | número inteiro | 10 | Base de dados max_overflow limite para SQLAlchemy. |
DB_POOL_SIZE | número inteiro | 2 | Tamanho do conjunto de conexões à base de dados para o SQLAlchemy. Com a opção «overflow», determina o número máximo de ligações simultâneas à base de dados. |
DB_POOL_TIMEOUT | número inteiro | 300 | Tempo limite do pool da base de dados para o SQLAlchemy. |
DB_USER ⭐️ | cadeia de caracteres | postgres | Utilizador do PostgreSQL para se ligar à Mergin Maps base de dados. |
| |
Gestão de utilizadores
Definições para a gestão de utilizadores.
Apenas na Enterprise Edition| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
AUTO-REGISTO DO UTILIZADOR | Booleano | verdadeiro | Os utilizadores podem registar-se por conta própria. Se esta opção estiver desativada, terão de ser convidados ou registados por um superutilizador. |
ENABLE_SUPERADMIN_ASSIGNMENT | Booleano | verdadeiro | Se estiver definido como «false», não será possível atribuir a função de superadministrador a um utilizador a partir do painel de administração. |
Gestão de permissões
Apenas na Edição ComunitáriaPara facilitar o processo de gestão de permissões (de utilizadores), pode definir as seguintes variáveis globais, que se aplicam a todos os utilizadores registados.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
GLOBAL_ADMIN | Booleano | false | Todos os utilizadores registados podem criar/eliminar projetos. |
GLOBAL_READ | Booleano | false | Todos os utilizadores registados têm acesso de leitura a todos os projetos. Se false, o administrador da aplicação teria de conceder manualmente acesso ao projeto aos utilizadores. |
GLOBAL_WRITE | Booleano | false | Todos os utilizadores registados têm acesso de escrita (podem sincronizar) a todos os projetos. |
Envio de e-mails
OMergin Maps pode ligar-se a um servidor SMTP para enviar notificações e e-mails de recuperação de palavra-passe.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
MAIL_SUPPRESS_SEND | Booleano | false | Se se deve impedir o envio de e-mails. Se estiver definido como false, deve definir as seguintes variáveis. |
MAIL_DEFAULT_SENDER⭐️ | cadeia de caracteres | Remetente dos Mergin Maps e-mails. É aconselhável ter um endereço de «não resposta». | |
MAIL_SERVER⭐️ | cadeia de caracteres | localhost | Host do servidor de correio SMTP. |
MAIL_PORT⭐️ | número inteiro | 587 | Porta do servidor de correio SMTP. |
MAIL_USERNAME | cadeia de caracteres | Nenhum | Nome de utilizador da pessoa que se liga ao servidor SMTP. |
MAIL_PASSWORD | cadeia de caracteres | Nenhum | Palavra-passe do utilizador que se liga ao servidor SMTP. |
MAIL_USE_TLS🛡️ | Booleano | verdadeiro | Utilize encriptação TLS ao estabelecer ligação ao servidor SMTP. |
MAIL_USE_SSL🛡️ | Booleano | false | Se se deve utilizar encriptação SSL ao estabelecer ligação ao servidor SMTP. |
MAIL_BCC | cadeia de caracteres | Nenhum | Endereço de e-mail para onde serão enviadas cópias de todos os e-mails enviados. Deve ser o administrador do sistema/aplicação. Obrigatório nas versões até 2024.4.0. |
MERGIN_LOGO_URL | cadeia de caracteres | Mergin Maps logótipo | Criar um link para o logótipo nos e-mails. |
Se tiver problemas ao enviar e-mails, consulte a página de resolução de problemas.
Gestão do espaço de trabalho
Definições do espaço de trabalho.
Apenas na Edição Comunitária| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
GLOBAL_WORKSPACE ⭐️ | cadeia de caracteres | fusão | Nome comum do espaço de trabalho para todos os projetos. Todos os projetos pertencem a este único espaço de trabalho, com determinadas permissões. Os projetos são, então, referenciados com este nome como parte do URL, por exemplo: /mergin/projetoA, /mergin/projectB. |
GLOBAL_STORAGE ⭐️ | número inteiro | 10737418240 | Limite de armazenamento Mergin Maps que pode ser utilizado para armazenar projetos (última versão) em bytes (o valor predefinido é 10 GB). Deve ser razoavelmente grande. |
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
WORKSPACE_STORAGE_SIZE ⭐️ | número inteiro | 524288000 | Limite de armazenamento que o espaço de trabalho pode utilizar para guardar projetos (última versão) em bytes (o valor predefinido é 500 MB). |
VALIDADE DO CONVITE PARA O ESPAÇO DE TRABALHO | número inteiro | 14 | Prazo de validade, em dias, para convites pendentes. |
PROJETO_TRANSFERÊNCIA_PRAZO DE VALIDADE | número inteiro | 7 | Prazo de validade, em dias, para a transferência de projetos pendentes. |
WORKSPACE_EXPIRATION | número inteiro | 7 | Período de validade, em dias, para os espaços de trabalho eliminados antes de serem removidos definitivamente. |
USER_WORKSPACES_ALLOWED | Booleano | verdadeiro | Permitir que os utilizadores criem os seus próprios espaços de trabalho; caso contrário, esta funcionalidade estará disponível apenas para o superutilizador |
Sincronização e gestão de dados
Outras definições relacionadas com a gestão de dados.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
PROJETOS LOCAIS | cadeia de caracteres | ./projetos | Diretório para armazenar projetos num contentor. Consulte o mapeamento de volumes no ficheiro docker-compose. |
TEMP_DIR | cadeia de caracteres | Resultado de gettempdir() chamada | A pasta «Trash», destinada a ficheiros temporários, é limpa regularmente. Consulte a configuração do mapeamento de volumes no ficheiro docker-compose. |
FICHEIRO_DE_MANUTENÇÃO | cadeia de caracteres | /data/MANUTENÇÃO | Ficheiro para indicar que o servidor se encontra em manutenção — modo de leitura apenas. Consulte o mapeamento de volumes no ficheiro docker-compose. |
LISTA NEGRA | cadeia de caracteres | .mergin/, .DS_Store, .diretório | Padrão a ignorar durante a sincronização de ficheiros. |
FILE_EXPIRATION | número inteiro | 172800 | Quando o ficheiro GeoPackage é atualizado com uma alteração«diffable», os dados originais são removidos (uma vez que podem ser reconstruídos sempre que necessário) para poupar espaço em disco. Duração do ficheiro em segundos. |
LOCKFILE_EXPIRATION | número inteiro | 300 | Tempo, em segundos, durante o qual um projeto fica bloqueado enquanto é atualizado. Se não ocorrer nenhuma alteração no projeto durante esse período, o ficheiro de bloqueio é removido. |
MAX_CHUNK_SIZE | número inteiro | 10485760 | Tamanho máximo de cada parte do ficheiro a carregar (e a receber pelo servidor) em bytes. |
MAX_DOWNLOAD_ARCHIVE_SIZE | número inteiro | 10737418240 | Tamanho máximo, em bytes, do ficheiro ZIP do projeto ou da versão do projeto (10 GB por predefinição) para descarregar a partir do painel de controlo. Os projetos demasiado grandes podem demorar muito tempo a descarregar. |
USE_X_ACCEL ⭐️ | Booleano | verdadeiro | Se se deve utilizar o nginx para servir ficheiros. Deve ser ativado se for utilizado com o proxy do nginx por motivos de desempenho. Saiba mais aqui. |
VENCIMENTO_DA_CONTA | número inteiro | 1 | Tempo, em dias, após um utilizador ter encerrado a sua conta até que todos os projetos e ficheiros sejam eliminados definitivamente. Tenha em atenção que, até que o utilizador seja removido, o nome de utilizador/e-mail permanece ocupado. |
EXPIRAÇÃO_DO_PROJETO_ELIMINADO | número inteiro | 7 | Período de validade, em dias, para projetos eliminados. Os projetos cujo prazo de validade tenha expirado são removidos definitivamente, sem possibilidade de recuperação posterior. |
PROJECT_ACCESS_REQUEST | número inteiro | 604800 | Duração da solicitação de acesso ao projeto ativo, em segundos. |
TEMP_EXPIRATION | número inteiro | 7 | Tempo, em dias, após a eliminação definitiva dos ficheiros numa pasta temporária. |
Tarefas assíncronas do Celery
Mergin Maps está a utilizar o Celery e o Redis para executar tarefas assíncronas ou tarefas regulares.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
BROKER_URL | cadeia de caracteres | redis://merginmaps-redis:6379/0 | Detalhes da ligação ao mediador de mensagens Celery. Se não for o valor predefinido, deve corresponder à definição em docker-compose ficheiro. |
CELERY_RESULT_BACKEND | cadeia de caracteres | redis://merginmaps-redis:6379/0 | Detalhes da ligação ao broker de resultados do Celery. Se não for o valor predefinido, deve corresponder à definição em docker-compose ficheiro. |
Registos de diagnóstico
Os utilizadores do plugin Mergin Maps e da aplicação móvel Mergin Maps podem enviar registos de diagnóstico a partir dos seus dispositivos. Em implementações personalizadas, os registos são armazenados em registos_de_diagnóstico pasta. Se pretender enviar estes registos para Mergin Maps em vez de os armazenar localmente, defina o DIAGNOSTIC_LOGS_URL variável para https://api.merginmaps.com/logs.
| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
DIAGNOSTIC_LOGS_URL | cadeia de caracteres | `` | Permite enviar registos de diagnóstico dos clientes para o URL especificado, em vez de os armazenar na pasta de implementação. Defina como https://api.merginmaps.com/logs para enviar registos de diagnóstico para Mergin Maps. |
WebMaps
Apenas na Enterprise Edition| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
MAPS_ENABLED | booleano | verdadeiro | Opção para ativar os mapas na Web |
VECTOR_TILES_URL | cadeia de caracteres | https://tiles-ee.merginmaps.com/data/default/{z}/{x}/{y}.pbf | URL dos mosaicos vetoriais utilizados como camada de mapa de fundo em mapas web |
VECTOR_TILES_STYLE_URL | cadeia de caracteres | https://tiles-ee.merginmaps.com/styles/default.json | URL de estilo de mosaicos vetoriais utilizada para definir o estilo da camada de fundo do mapa em mapas web |
Autenticação Única (SSO)
Apenas na Enterprise Edition| Nome da variável | Tipo | Padrão | Descrição |
|---|---|---|---|
SSO_ENABLED | booleano | false | Opção para ativar o SSO em Mergin Maps |
SSO_SERVER_URL ⭐️ | cadeia de caracteres | http://localhost:8081 | URL pública do servidor SSO. Esta URL deve estar acessível a partir da Internet. |
SSO_SERVER_API_KEY ⭐️ | cadeia de caracteres | `` | Esta chave API é utilizada para autenticar os pedidos enviados ao serviço SSO. Deve ser uma das chaves definidas no JACKSON_API_KEYS variável no âmbito da Ory Polis (para mais detalhes, ver Guia de implementação do Single Sign-On). |