This repository is a web-oriented software platform of the OSTIS Project and is intended to be a solid framework to help you deploy existing and create new OSTIS systems.
OSTIS Web platform contains:
- Knowledge base with top-level ontologies to help you develop a broad variety of information models
- Knowledge processing machine with semantic network storage and agent-based knowledge processing
- Web-oriented semantic interface for users to interact with the intelligent system.
To learn more about the platform, check out our documentation.
-
Quick start using Docker Compose
Additional steps for Windows users
Make sure you are using UNIX line endings inside the repository and
longpaths
are enabled, otherwise you may face problems during build or installation process. Use the commands below to reconfigure Git on your machine:git config --global core.autocrlf input git config --global core.longpaths true
Requirements: you will need Docker installed and running on your machine.
git clone https://github.com/ostis-ai/ostis-web-platform cd ostis-web-platform # download images from Docker Hub docker compose pull # download KB and LaTeX docs plugin git submodule update --init --recursive # build knowledge base docker compose run machine build # launch web platform stack docker compose up
Building docker images locally
This may come in handy e.g. when you want to use a custom branch of the sc-machine or sc-web.
- In case you're using Windows, set up git using the installation instructions above
- Enable Docker BuildKit. You can use
DOCKER_BUILDKIT=1
shell variable for this.
git clone https://github.com/ostis-ai/ostis-web-platform git submodule update --init --recursive cd scripts ./prepare.sh no_build_sc_machine no_build_sc_web # download all submodules without compilation. cd .. docker compose build
-
Natively
Note: Currently, only Ubuntu is supported by this installation method. If you're going to use it, it might take a while to download dependencies and compile the components. Use it only if you know what you're doing!
cd ostis-web-platform/scripts/ ./prepare.sh
-
Docker Compose
# build the Knowledge Base. # Required before the first startup (or if you've made updates to KB sources) docker compose run machine build # start platform services and run web interface at localhost:8000 docker compose up
-
Native installation
# Build knowledge base cd ostis-web-platform/scripts/ ./build_kb.sh # Launch knowledge processing machine cd ostis-web-platform/scripts/ ./run_sc_server.sh # *in another terminal* # Launch semantic web interface at localhost:8000 cd ostis-web-platform/scripts/ ./run_scweb.sh
We document all information about the project development and its components' implementation in sources of its knowledge base to provide opportunity to use it in information processing and knowledge generation.
You can access the current version of the documentation in docs/main.pdf file of this project.
Documentation is written with the help of LaTeX tools in SCn-code representation. To build documentation manually, you'll need a LaTeX distribution installed on your computer. Alternatively, we provide a Docker image to build the documentation in case you can't / don't want to install LaTeX on your PC.
# feel free to skip this step if the platform is already installed natively
cd ostis-web-platform/scripts
./prepare.sh no_build_sc_machine no_build_sc_web
-
cd ostis-web-platform/docs TEXINPUTS=./scn: latexmk -pdf -bibtex main.tex
-
cd ostis-web-platform docker run -v ${PWD}:/workdir --rm -it ostis/scn-latex-plugin:latest "docs/main.tex"
After the compilation, the
main.pdf
file should appear atostis-web-platform/docs/
. You can find more information about scn-latex-plugin here.
Contributions, bug reports and feature requests are welcome! Feel free to check our issues page and file a new issue (or comment in existing ones).
Distributed under the MIT License. See LICENSE for more information.