mirror of
https://github.com/naturalcrit/homebrewery.git
synced 2025-12-24 20:42:43 +00:00
ba600f5da6
* Update server.js Eliminate requirement to CD into project directory prior to running `npm start` or `node server.js`. * Add rc.d daemon script Adds a RC.d daemon script to control the HomeBrewery status. Based on Andrew Pearson's Node-RED script for the same purpose. * Create install.sh * Update install.sh * Update install.sh Switch to latest version of MongoDB * Add config items Add config items and default values: - web_port (8001) - environment (local) * Remove environment variables from rc.d Remove environment variables from rc.d as they are now in config/default.json. * Update server.js Change to setting NODE_ENV; default to 'local' if not set via environment variable or in the config file. * Remove --force option Remove --force option from `npm audit fix`. While this has not caused any issues to date, there is no guarantee that it will continue to be the case. * Create README.FREEBSD.md Initial write up of install instructions. Includes instruction to `wget` from the `naturalcrit/homebrewery` project rather than the FreeBSD fork, on the assumption that the PR will be merged at some point. * Update install.sh Change to main project repo, on assumption that the PR will be merged at some point * Change install directory Change of install directory to `/usr/local/homebrewery` * Update homebrewery Add `dev_mode` to the HomeBrewery service, which starts the HomeBrewery project in live rebuild mode. * Update server.js Eliminating unnecessary debugging code, reducing line count and making lint happy :) * Update server.js Lint is happy, now attempting to pacify CircleCI * Move NODE_ENV to service file; remove from server.js and config/default.json * Remove hanging comma in config.json Change default port assignment from 8000 to 8001 in config.json and FreeBSD service config * Add link to FreeBSD install documenation in the main README.md file * Fix for MongoDB package update breaking install script Change to enable use of rcvars for NODE_ENV and PORT
36 lines
1.8 KiB
Markdown
36 lines
1.8 KiB
Markdown
# FreeBSD/FreeNAS Installation Instructions
|
|
|
|
## Before Installing
|
|
|
|
These instructions assume that you are installing to a completely new, fresh FreeBSD/FreeNAS jail. As such, some steps will not be necessary if you are installing to an existing FreeBSD/FreeNAS install.
|
|
|
|
## Installation instructions
|
|
|
|
1. Create a new jail, with the appropriate network settings to access the internet.
|
|
|
|
2. Install wget (`pkg install -y wget`). On a fresh jail, you will be prompted to press 'Y' to set up `pkg`.
|
|
|
|
3. Download the installation script (`wget --no-check-certificate https://raw.githubusercontent.com/naturalcrit/homebrewery/master/freebsd/install.sh`). The parameter `--no-check-certificate` is required as we haven't set up any trusted certificates/authorities yet.
|
|
|
|
4. Make the downloaded file executable (`chmod +x install.sh`).
|
|
|
|
5. Run the script (`./install.sh`). This will automatically download all of the required packages, install both them and HomeBrewery, configure the system and finally start HomeBrewery.
|
|
|
|
**NOTE:** At this time, the script **ONLY** installs HomeBrewery. It does **NOT** install the NaturalCrit login system, as that is currently a completely separate project.
|
|
|
|
---
|
|
|
|
### Testing
|
|
|
|
These installation instructions have been tested on the following FreeBSD/FreeNAS platforms:
|
|
|
|
* FreeNAS-11.3-U5; Jail 11.4-RELEASE-p2
|
|
|
|
## Final Notes
|
|
|
|
While this installation process works successfully at the time of writing (December 28, 2020), it relies on all of the Node.JS packages used in the HomeBrewery project retaining their cross-platform capabilities to continue to function under FreeBSD. This is one of the inherent advantages of Node.JS, but it is by no means guaranteed and as such, functionality or even installation under FreeBSD may fail without warning at some point in the future.
|
|
|
|
Regards,
|
|
G
|
|
December 28, 2020
|