wolfreealpha-bash/README.md

75 lines
2.7 KiB
Markdown
Raw Normal View History

2023-03-10 11:40:40 +00:00
# WolfreeAlpha Bash Installer
This is a "simple" bash script to install
[WolfreeAlpha](https://try.gitea.io/wolfree/wolfree-dockerfile/) on your system
without using Docker, because, let's face it, that's a bit overkill for a
static site.
It downloads publically available files from WolframAlpha, stores them in a
local directory, and allows you to serve them with your webserver of choice.
It applies the patches from the WolfreeAlpha Dockerfile, allowing it to provide
additional features like step-by-step solutions, which are normally only
available in the paid version.
## Requirements
Technically, this script should work on any system where bash, wget, grep and
sed are available. However, we only tested it on Debian 11.6 and Arch Linux.
## Usage
To install WolfreeAlpha, you can run the following command as a user that has
write access to the destination directory (by default: /srv/wolfree/):
```bash
wget -qO- https://kumig.it/PrivateCoffee/wolfreealpha-bash/-/raw/main/wolfree.sh | bash
```
Of course, you should never run random scripts from the internet without
reading them first. So, if you want to make extra sure that this script is
safe, you can download it, read it and then run it locally:
```bash
wget https://kumig.it/PrivateCoffee/wolfreealpha-bash/-/raw/main/wolfree.sh
bash wolfree.sh
```
## Configuration
At the top of the script, you can find the `DESTINATION` variable. This is the
directory where WolfreeAlpha will be installed. You can change it to whatever
you want.
Note that this script will not set up a webserver for you. You will have to do
that yourself and make it serve the destination directory. No PHP or any other
magic is required, you only have to serve the static files. How that works is
beyond the scope of this README, but your webserver of choice usually comes
with a default configuration that does just that, or you can find a tutorial
on the Interwebz.
## Updating
To update WolfreeAlpha, you can simply re-run the script. It will delete the
old installation and overwrite it with the new one.
## Uninstalling
To uninstall WolfreeAlpha, you can simply delete the destination directory and
delete the webserver configuration for it.
## Disclaimer
This script is not affiliated with Wolfram Research or the original
WolfreeAlpha project in any way. It is provided as-is and without any
warranty.
Furthermore, it is your responsibility to make sure that you are allowed to
install and provide WolfreeAlpha on your system. We are not responsible for any
legal issues that may arise from using this script.
## License
This script, just like the original WolfreeAlpha Dockerfile, is licensed under
the GNU Affero General Public License. You can find a copy of the license in
the [LICENSE](LICENSE) file.