Saltar para o conteúdo principal

Início rápido

Isto leva-o do zero a uma instância em execução. Precisa de Docker com Compose v2.

1. Obtenha os ficheiros de implementação​

Os ficheiros de auto-alojamento estão na pasta deploy/ do ramo next.

git clone --branch next https://github.com/notacamp/campbooks
cd campbooks/deploy

2. Crie o ficheiro de definições​

Copie o exemplo. Todas as definições vivem neste único ficheiro .env.

cp .env.example .env

3. Defina os dois valores obrigatórios​

Abra o .env e defina pelo menos estes dois. POSTGRES_PASSWORD deve usar apenas caracteres seguros para URL, porque é incorporada num URL de ligação. openssl rand -hex 24 gera uma boa. CAMPBOOKS_PUBLIC_URL é o endereço que as pessoas usam para aceder à sua instância. Também serve para construir as ligações de convite.

POSTGRES_PASSWORD=change-me
CAMPBOOKS_PUBLIC_URL=https://campbooks.example.com

Para um teste na sua máquina, use http://localhost:8080 como URL público e acrescente CAMPBOOKS_ENV=development ao .env. O http:// simples só é aceite em desenvolvimento. Nunca use CAMPBOOKS_ENV=development num servidor a que outras pessoas possam aceder: uma instalação real usa https:// e deixa CAMPBOOKS_ENV por definir.

4. Arranque​

Isto arranca o servidor e o Postgres (com pgvector). O início de sessão está incluído no servidor, por isso não há um serviço separado para ele. No primeiro arranque, um serviço pontual gera também a chave secreta da instância. Guarde uma cópia (veja Atualizações e cópias de segurança).

docker compose up -d

5. Verifique que está saudável​

O endpoint de saúde confirma que o servidor consegue chegar à base de dados.

curl http://localhost:8080/api/v1/system/health

Deve receber isto:

{"status":"ok","database":"ok"}

6. Abra a aplicação e inicie sessão​

O servidor responde com a aplicação web na porta 8080. Se não tiver sessão iniciada, envia-o para o ecrã de início de sessão e de volta. As pessoas iniciam sessão com Google, Microsoft, Zoho ou uma chave de acesso. Para oferecer um fornecedor, registe primeiro a respetiva aplicação OAuth (veja Início de sessão).

http://localhost:8080/

7. Crie o primeiro espaço de trabalho​

A primeira pessoa a iniciar sessão cria o primeiro espaço de trabalho. Convide as outras em Definições, depois Membros. Os convites ainda não são enviados por email: recebe a ligação uma só vez, logo após convidar, e envia-a você. Veja Início de sessão para saber quem mais pode criar um espaço de trabalho.

Próximos passos​

Última atualização em