From 1852cfe853373809d2b247e21ae4fb19ef0909fd Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Sat, 31 Aug 2024 13:16:43 +0200 Subject: [PATCH 1/2] More elaborate example for db vacuuming --- docs/_docs/admin/administration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/_docs/admin/administration.md b/docs/_docs/admin/administration.md index 979dfe70c..2f598a3e2 100644 --- a/docs/_docs/admin/administration.md +++ b/docs/_docs/admin/administration.md @@ -42,5 +42,7 @@ SQLite database files become less performant over time and waste space. It is re Example: ```bash -sqlite3 ./db/message.sqlite3 "vacuum;" +for dbfile in /path/to/enigma-bbs/db/*.sqlite3; do + sqlite3 ./db/message.sqlite3 "vacuum;" +done ``` From b97018b11a0eedbbed7ed09d4fe263b922719dc1 Mon Sep 17 00:00:00 2001 From: voipmeister <12763807+voipmeister@users.noreply.github.com> Date: Sat, 31 Aug 2024 13:24:21 +0200 Subject: [PATCH 2/2] Updated manual installation doc --- docs/_docs/installation/manual.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/_docs/installation/manual.md b/docs/_docs/installation/manual.md index 2b4c40b0e..fd60b8a88 100644 --- a/docs/_docs/installation/manual.md +++ b/docs/_docs/installation/manual.md @@ -22,21 +22,22 @@ are OK) for Windows users. Note that you **should only need the Visual C++ compo Node Version Manager (NVM) is an excellent way to install and manage Node.js versions on most UNIX-like environments. [Get the latest version here](https://github.com/creationix/nvm). The nvm install may look _something_ like this: ```bash -curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash ``` > :information_source: Do not cut+paste the above command! Visit the [NVM](https://github.com/creationix/nvm) page and run the latest version! Next, install Node.js with NVM: ```bash -nvm install 14 -nvm use 14 -nvm alias default 14 +nvm install 18 +nvm use 18 +nvm alias default 18 ``` If the above steps completed without errors, you should now have `nvm`, `node`, and `npm` installed and in your environment. For Windows nvm-like systems exist ([nvm-windows](https://github.com/coreybutler/nvm-windows), ...) or [just download the installer](https://nodejs.org/en/download/). +> :information_source: Please note that Node v18 is the latest release that is supported for ENiGMA BBS. Support for Node v20 is being worked on in [this Github issue](https://github.com/NuSkooler/enigma-bbs/issues/539). ## ENiGMA BBS ```bash @@ -48,6 +49,7 @@ git clone https://github.com/NuSkooler/enigma-bbs.git cd enigma-bbs npm install # yarn also works ``` +> :information_source: At the moment you might see a few warnings about packages being deprecated or replaced. This is a known issue that will be resolved in the future. ## Other Recommended Packages ENiGMA BBS makes use of a few packages for archive and legacy protocol support. They're not pre-requisites for running ENiGMA, but without them you'll miss certain functionality. Once installed, they should be made available on your systems `PATH`.