Building WebHare from source
Clone the repository (the examples assume we're extracting to
mkdir ~/projects cd ~/projects git clone firstname.lastname@example.org:webhare/webhare.git
Now setup the
wh tool by adding this to your
~/.profile (or equivalent .bashrc of .bash_profile):
and relogging in or restarting your terminal session.
eval `~/projects/webhare/whtree/bin/wh setupmyshell`
See wh for more information about the wh tool. All other documentation
will assume you've set this up and just refer to
wh when they want you to
Make and install:
The build process will attempt to estimate a proper number of parallel jobs to use (
make -j...) but you can control the
number of processors used by
wh make and
wh mic by setting a
WHBUILD_NUMPROCS=nnn variable eg
WHBUILD_NUMPROCS=4 wh make.
You should never set the number of build processors too high - the build process is highly parallel and can easily overwhelm a system.
Setup default interface port for WebHare:
wh setup 8000
wh fixmodules once to update NPM dependencies.
Visit the provided URL and finish the install wizard.
builddocker will set up a ccache server for faster (re)builds, unless it recognizes it's running under a CI environment.
On OSX, the make scripts expects the instantclient headers and libraries to be in
/usr/local/instantclient/ - just grab them from https://www.oracle.com/technetwork/topics/intel-macsoft-096467.html and extract their contents there
Advanced build options
WHBUILD_DEBUG=1 - Use whbuild.debug and build versions with extra debugging
To quickly run a specific blextest, eg 'string' (you really want this when editing stringmanip.cc):
BLEXTEST=string WHBUILD_NODEPS=1 wh make blex-test
Troubleshooting common build failures
Try repeating the make command. If you only see 'error' or 'waiting for finished jobs' you may have to scroll up a bit to find the error (make often runs multiple tasks at the same time. if one task reported an error, it will finish the other running jobs so you may need to look for the error).
Before you try anything else, make sure you are up-to-date and try the fixbuild option and see if it fixes your issue:
# This executes various cleanup steps that usually fix ICU or NPM issues wh fixbuild
"No rule to make target"
These errors are usually fixed by running
wh make clean-deps
If tests are failing and you want to ignore this, run
NOTEST=1 wh mic.
"TestLocalization: VersionTest yielded errors"
If 'got' is lower than 'expected', you need to update your ICU library. On OSX, a 'brew update' will update your brew definitions, after which it should carry out this update.
If 'got' is higher than 'expected', update or let us know.
"Library not loaded: /usr/local/opt/icu4c/lib/libicui18n.55.dylib Referenced from: /wh/whbuild/blex/tests/dynamic.dylib"
This error, and similar errors, may be caused by updating libraries (especially when the error refers to an older version of the library, like icu v55 above). Try
wh make clean-libs to remove all compiled libraries
lib/hsm_wh_icu.dylib Error 1
There were probably errors building the icu provider, and the autodependency checking tends to be bad at picking up icu recompiles, at least on OSX.
wh make clean-icu-provider to specifically reset the ICU module. If ICU issues persist, consider downgrading to an earlier version. On OSX with brew:
# Show available versions brew list --versions icu4c # this will return something like: icu4c 59.1_1 60.2 # Pick an earlier version brew switch icu4c 59.1_1
This is usually caused by broken or out-of-date command line tools on OSX.
Update Xcode, start Xcode and make sure you accepted the EULA and it got a chance to download updated command line tools.
After this, you'll probably have to go through a 'wh fixbuild'.
If you're about to give up:
# Discard build directory and resetup the build proces rm -rf ~/projects/whbuild && wh setupbuild && wh mic