AIL/ail-framework
8
0
Fork 0
mirror of https://github.com/ail-project/ail-framework.git synced 2025-02-07 09:56:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix: Update README with docker installation process for Linux, Windows and Mac and made some changes to the styling of the README so that is easier to understand

Browse source
This commit is contained in:
FilipeS0usa 2025-01-05 00:01:19 +00:00
parent 9e8ff182e7
commit faec11f009
1 changed files with 36 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
other_installers/docker/README.md
View file

@ -6,28 +6,54 @@ This Docker is not maintained at the moment.
If you are interested to contribute, please submit a Pull Request
1. Install Docker
```bash
sudo su
apt-get install -y curl
curl https://get.docker.com | /bin/bash
```
# Have docker Installed
## Linux Installation
Here is the [link](https://docs.docker.com/engine/install/) with the installation
steps for all the diferent linux Platforms.
If your distro is not mentioned you probably need to install it through the
package manager of the distro that you are using (Ex.: ArchLinux, NixOS).
## Windows Installation
To be able to run docker on a Windows device you will have to check the documentation
on how to install it on windows.
If I'm not mistaken you have 2 ways of installing docker on windows:
- Only using the WSL with an Ubuntu image, in this case you follow the
same [installation steps](https://docs.docker.com/engine/install/ubuntu/) as
you would in an Ubuntu distro.
- Using the [Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/)
## Mac Installation
For mac users follow the [documentation](https://docs.docker.com/desktop/setup/install/mac-install/)
# Build the docker image
Type these commands to build the Docker image:
2. Type these commands to build the Docker image:
```bash
git clone https://github.com/ail-project/ail-framework.git
cd AIL-framework
cd ail-framework
cp -r ./other_installers/docker/Dockerfile ./other_installers/docker/docker_start.sh ./other_installers/docker/pystemon ./
cp ./configs/update.cfg.sample ./configs/update.cfg
vim/nano ./configs/update.cfg (set auto_update to False)
docker build --build-arg tz_buildtime=YOUR_GEO_AREA/YOUR_CITY -t ail-framework .
```
3. To start AIL on port 7000, type the following command below:
# Start AIL
To start AIL on port 7000, type the following command below:
```
docker run -p 7000:7000 ail-framework
```
4. To debug the running container, type the following command and note the container name or identifier:
# Debug Container
To debug the running container, type the following command and note the container name or identifier:
```bash
docker ps
```