README.md

July 9, 2025 ยท View on GitHub

Docker Build (Optional)

We further provide an optional Docker file which can be used to build working env with Docker.

  1. Install docker to the system (skip the step if docker has been already installed):

    sudo apt install docker
    
  2. To start your docker environment, please go to the folder dockerfiles:

    cd dockerfiles
    
  3. Create a docker image (you can put any name you want):

    docker build --tag 'fakestormer' .
    
  4. Check the status of the image created:

    1. Run command:

      docker image ls
      
    2. You should see something similiar:

      REPOSITORYIMAGE IDCREATEDSIZETAG
      fakestormerefd42237075012 minutes ago18.4GBlatest
  5. Run a container from the created image:

    1. Run command
      docker run -v <data_path>:<path_in_container> --gpus 'all,capabilities=utility' -it fakestormer /bin/bash
      
    2. Check the container created:
      1. Run command:
        docker ps
        
      2. Check the result:
        CONTAINER IDIMAGECOMMANDCREATEDSTATUSPORTSNAMES
        0203c192febbfakestormer"/bin/bash"29 seconds agoUp 28 secondsdetermined_cannon
      3. To access the docker container:
        docker exec -it 0203c192febb /bin/bash
        
      4. To start the container:
        docker start 0203c192febb
        
      5. To stop the container:
        docker stop 0203c192febb
        
  6. Inside the docker container, you can clone or mount the repository from outside:

    cd /workspace/
    git clone https://github.com/10Ring/FakeSTormer.git
    cd FakeSTormer/
    
  7. Now you are ready for QuickStart