Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor doc changes #556

Merged
merged 3 commits into from
Aug 31, 2024
Merged

Minor doc changes #556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1852cfe
More elaborate example for db vacuuming
voipmeister Aug 31, 2024
b97018b
Updated manual installation doc
voipmeister Aug 31, 2024
9af425c
Merge branch 'master' of https://github.com/voipmeister/enigma-bbs
voipmeister Aug 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/_docs/admin/administration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
10 changes: 6 additions & 4 deletions docs/_docs/installation/manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

```
> :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
Expand All @@ -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`.
Expand Down
Loading