Unverified Commit b868b87a authored by Ankur Kumar's avatar Ankur Kumar
Browse files

Update instructions for using custom mine

parent 029a0d05
......@@ -22,31 +22,53 @@ to visit your mine (yes it is that easy now!!)
## Customizing your mine instance
### Using a custom mine
You can use your custom mine for the builds. Just set the git url of your mine to the env var `MINE_URL`. (directory structure similar to biotestmine is assumed)
You can use your custom mine for the builds.
- First set the git url of your mine to the env var `MINE_REPO_URL`. (directory structure similar to biotestmine is assumed)
If you do not have your mine hosted on github/gitlab then you can also mount your mine files directly to the build container. Just add your mine folder inside /data/mine folder created by docker compose and uncomment the following line in the docker-compose.yml file.
```
# - ./data/mine/[PUT_YOUR_MINE_NAME_HERE]:/home/intermine/intermine/ [PUT_YOUR_MINE_NAME_HERE]
```
> Note: build will do a few changes to your mine files when mine files are directly mounted to the build container. So, it is recommended to use a copy of your mine for the build. This is not the case when you are using MINE_REPO_URL to pull mine files.
- Then set `MINE_NAME` env var to your mine name.
> Make sure that the folder name matches with your mine name.
- Finally set `IM_DATA_DIR` env var to the data dir prefix that you have in your project.xml file. This will be used for search and replace to fix data locations inside the build container.
If you do not have your mine hosted on github then you can also mount your mine files directly to the container. Just add your mine files inside /data/mine folder created by docker compose and uncomment the respective lines
in the docker-compose.yml file.
### Adding data and project configs
After quickstart you have a data folder created at your current working directory.
After quickstart you have a data folder created at your current working directory.
Add your data files to **`data/mine/data`** folder.
You can also create the folder structure on your own if you do not want to do a quickstart. Just create a folder structure like `data/mine/data`
> Remeber to create a folder for each of your data files
Add your data files to **`data/mine/data`** folder. If you do not want to copy your data files over then just change location of data files from **`data/mine/data`** folder to your desired folder location in docker-compose.yml file.
Add your config files to **`data/mine/config`** folder.
> Remeber to create a folder for every data source you use.
Add your config files to **`data/mine/config`** folder. Configs include your project.xml file.
### Changing default settings
You can configure a lot of options by just creating a .env file in the current working directory and adding the required key value pairs.
You can configure a lot of options by just creating a .env file in the current working directory and adding the required key value pairs. These are used as env vars by docker-compose.
Available options are:
- MINE_NAME
- Set your desired mine name here.
- MINE_URL
- Add you mine github url. It will be used to pull your mine inside build container
> You can also mount your mine files directly to the container. Just add your mine files inside /data/mine folder created by docker compose and uncomment the respective lines
in the docker-compose.yml file.
Set your desired mine name here.
- MINE_REPO_URL
Add you mine github/gitlab url. It will be used to pull your mine inside build container
- IM_DATA_DIR
Set it to the data dir prefix that you have in your project.xml file. This will be used for search and replace to fix data locations inside the build container.
- TOMCAT_HOST_PORT
- Set the port of your host machine to which tomcat docker container binds to. This is the port that you will use to access the mine webapp.
Set the port of your host machine to which tomcat docker container binds to. This is the port that you will use to access the mine webapp.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment