No description
Find a file
Florian Schmitt 751b00d714
All checks were successful
deploy to prod / Build and deploy site (push) Successful in 31s
fix: broken links wouln't build
2024-10-01 15:43:21 +03:00
.forgejo/workflows set build-images action to manual start 2024-10-01 11:49:33 +00:00
.github/workflows implement deploy in deploy action 2024-09-26 10:23:01 +02:00
.vitepress fix: broken links wouln't build 2024-10-01 15:43:21 +03:00
bin add safeguard against running from another branch than main in push-to-prod script 2024-09-26 22:26:07 +02:00
components fix build and improve roadmap 2024-10-01 11:34:47 +03:00
inventory feat: better vm doc, remove init options 2024-09-30 16:52:30 +03:00
public update logo 2024-09-26 11:13:43 +02:00
.gitignore feat: build instructions and example 2024-09-28 20:11:22 +03:00
about.md fix: broken links wouln't build 2024-10-01 15:43:21 +03:00
build-virtual-machine.md feat: better vm doc, remove init options 2024-09-30 16:52:30 +03:00
configure.md feat: ConfigForm component and empty doc files 2024-09-24 13:46:27 +03:00
index.md fix: broken links wouln't build 2024-10-01 15:43:21 +03:00
installation.md feat: about page + tweaks + links between pages 2024-10-01 15:35:14 +03:00
LICENSE initial commit 2024-09-24 10:14:24 +03:00
package-lock.json feat(shell): better package name, install npm deps, show options 2024-09-30 15:41:33 +03:00
package.json feat(shell): better package name, install npm deps, show options 2024-09-30 15:41:33 +03:00
README.md update readme 2024-09-26 22:46:27 +02:00
roadmap.md full roadmap 2024-10-01 13:56:55 +03:00
shell.nix feat(shell): better package name, install npm deps, show options 2024-09-30 15:41:33 +03:00
technical-principles.md work on technical-principles.md 2024-09-30 16:25:24 +02:00

NixiN Web

Building the web site

npm run docs:build

Testing localy

npm run docs:dev

Manually deploying to a server usign sftp

pushd .vitepress/dist/ ; echo "put -r *" | sftp -b - -N user@server.domain.tld:www ; popd

Automatically deploying to a server with forgejo action

Development is taking place in the main branch, or in feature branches that are then merged into main. To deploy the web site to production server the changes in main branch are merged to the prod branch, which is triggering the deploy action, defined in .forgejo/workflows/deploy.yaml This action builds the web site (npm run docs:build) and then deploys it to the production server using sftp with public/private key authentiction

You can use the script in bin/push-to-prod.sh to perform the merge of main branch into prod branch

if you forked this repository, you need to create the secrets needed by the deploy action (in repository settings->actions->secrets) :

  • DEPLOY_USER : OS user to connect to production server
  • DEPLOY_TARGET : sftp target where the web site has to be deployed, in the form of server.domain.tld:path
  • DEPLOY_SSH_PRIVATE_KEY : private ssh key used to authenticate with the server and configure the server witht the public key corresponding to DEPLOY_SSH_PRIVATE_KEY