diff --git a/README.md b/README.md index 9819e44..8a9fcb6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # Minisat documentation -Documentation for Minisat + + +### About the book + +This book contains am elaborated summary about installation and usage of Minisat. It will help user in installation and understanding of all component. Also help developer, how to contribute to Minisat. diff --git a/chapter_1/minisat_installation.md b/chapter_1/minisat_installation.md index 8259589..7b52fc9 100644 --- a/chapter_1/minisat_installation.md +++ b/chapter_1/minisat_installation.md @@ -21,19 +21,34 @@ curl -L https://github.com/docker/machine/releases/download/v0.13.0/docker-machi sudo install /tmp/docker-machine /usr/local/bin/docker-machine ``` -+ Server should have HTTP service installed and running. ++ Server should have SSH public key or it can be generated using SSH keygen. ```sh -dnf install httpd -y +ssh-keygen ``` -+ Server should have SSH public key or it can be generated using SSH keygen. +#### Installation +###### From Docker +To run Minisat using docker, first clone the Github Minisat repository using and go to directory Minisat ```sh -ssh-keygen +git clone https://github.com/miniSat/minisat.git +cd Minisat ``` +Now build docker image for Minisat using +```sh +docker build -t minisat:latest . +``` +Hang on building docker image may take time depending on your internet speed. + +After building the image now run the image using +```sh +docker container run -it -p 8000:8000 minisat:latest 0.0.0.0:8000 +``` +Head to http://localhost:8000 for Minisat + +###### From Source code -#### Installation Minisat uses Django web framework which can be installed in Python 3 virtual environment. To create Python 3 virtual environment ```sh python3 -m venv diff --git a/components/create_host.md b/components/create_host.md new file mode 100644 index 0000000..0c1f24c --- /dev/null +++ b/components/create_host.md @@ -0,0 +1 @@ +# Host Group diff --git a/how_to_start_with_minisat/README.md b/how_to_start_with_minisat/README.md index bedc05b..9dd1387 100644 --- a/how_to_start_with_minisat/README.md +++ b/how_to_start_with_minisat/README.md @@ -7,7 +7,7 @@ This section is divide into two parts: * Creating Virtual Machine * Creating Docker Instances -Before proceeding further make sure you have gone through [**Minisat Installation**](http://localhost:8004/chapter_1/minisat_installation.html) section because it consist of all the prerequisite that are required to setup and start Minisat server. +Before proceeding further make sure you have gone through [**Minisat Installation**](/chapter_1/minisat_installation.html) section because it consist of all the prerequisite that are required to setup and start Minisat server. diff --git a/how_to_start_with_minisat/creating_docker_instances.md b/how_to_start_with_minisat/creating_docker_instances.md index a5dcc41..3557892 100644 --- a/how_to_start_with_minisat/creating_docker_instances.md +++ b/how_to_start_with_minisat/creating_docker_instances.md @@ -1,8 +1,8 @@ -*# Running Docker Containers +# Running Docker Containers Docker containers are created either from existing local images or by pulling images from Docker registry and then running them. -###Step 1### +###Step 1 First you need to create compute resource. @@ -15,7 +15,7 @@ To do so click on Infrastructure => Compute Resource >If you have already added compute for virtual machine no need to create again, same compute can be used for containers also. -###Step 2### +###Step 2 The previous step will now allow the server to perform SSH on remote Docker server and gather container related facts. @@ -27,7 +27,7 @@ To run a container from Docker image * Provide the host port and container port * Select compute resource -###Step 3### +###Step 3 Finally hit `Run` to run container. Check running running containers on dashboard under Docker containers tab. diff --git a/how_to_start_with_minisat/creating_virtual_machines.md b/how_to_start_with_minisat/creating_virtual_machines.md index 204219f..a80921b 100644 --- a/how_to_start_with_minisat/creating_virtual_machines.md +++ b/how_to_start_with_minisat/creating_virtual_machines.md @@ -1,7 +1,7 @@ # Creating Virtual Machines Follow the steps carefully so that you dont get any error while creating virtual machine. The steps are very easy only need is to follow them in order. -###Step 1### +###Step 1 First you need to create compute resource.