Merge pull request #24 from gitopia/improve-build-instructions

Improve build instructions

Author: harry-hov

config_local.toml

@@ -1,4 +1,4 @@
-web_server_port = 5001
+web_server_port = 5000
 gitopia_grpc_url = "localhost:9090"
 git_dir = "/var/repos"
 attachment_dir = "/var/attachments"

readme.md

@@ -6,6 +6,7 @@ gitopia services for [gitopia](https://gitopia.org/)
 
 ### Build
 
+By default, git-server is built with local configurations. If you want to build with `PRODUCTION` or `DEVELOPMENT` configurations, pass a build arg `ENV` with respective value.
 ```
 docker build . --build-arg USER=<USER> \
   --build-arg PERSONAL_ACCESS_TOKEN=<PERSONAL_ACCESS_TOKEN> \
@@ -22,11 +23,14 @@ To start the server, execute the following command
 ```sh
 docker run -it \
   --name git-server \
-  --mount type=bind,source="$(pwd)/../tmp",target=/var/attachments \
-  --mount type=bind,source="$(pwd)/../tmp",target=/var/repos -p 5000:5000 \
+  --mount type=bind,source=/var/attachments,target=/var/attachments \
+  --mount type=bind,source=/var/repos,target=/var/repos -p 5000:5000 \
   git-server
 ```
 
+> **Important**  
+> Make sure that `source`, `target` in the docker run command and the `git_dir` in the configuration file have the same path. This is required because forked repositories link to parent repositories via the git alternates mechanism wherein the absolute path of the parent repository is stored in the forked repository's alternates file.
+
 The server will be listening at port `5000`
 
 ### Available APIs