Skip to content

Commit

Permalink
Merge Dev - V1.0.0 candidate
Browse files Browse the repository at this point in the history
Dev - V1.0.0 candidate
  • Loading branch information
amir-zeldes authored Nov 8, 2018
2 parents 52f4812 + ab8b3ac commit eef6202
Show file tree
Hide file tree
Showing 55 changed files with 3,726 additions and 2,224 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# compiled python files
**.pyc

# these are auto-generated in index.py
popupPage.html
popupPageCorpus.html

# usually don't want to commit this
gitdox.db
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM ubuntu:18.04
FROM ubuntu:16.04
EXPOSE 80

# install deps
Expand All @@ -13,8 +13,7 @@ RUN chown -R www-data:www-data /var/www/html
RUN chmod +x /var/www/html/*.py
RUN chmod +x /var/www/html/modules/*.py

# keep these in sync with requirements.txt
RUN pip install lxml requests github3.py==0.9.3 passlib
RUN pip install -r /var/www/html/requirements.txt

# install ethercalc and run as a service
RUN npm install -g ethercalc
Expand Down Expand Up @@ -47,6 +46,7 @@ RUN echo " \n\
# service and (2) not to use supervisord to manage the execution of these
# processes. But (1) is too heavy a solution, and (2) seems unnecessary unless
# one of our services leaks memory/is unstable
RUN echo "ln -s /usr/bin/nodejs /usr/bin/node" >> /etc/startup.sh
RUN echo "/usr/bin/redis-server &" >> /etc/startup.sh
RUN echo "/usr/local/bin/ethercalc &" >> /etc/startup.sh
RUN echo "/usr/sbin/apache2ctl -D FOREGROUND" >> /etc/startup.sh
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ hope to provide a stable release soon.
First, [install Docker](https://docs.docker.com/install/). You may be able to
install it using your platform's package manager.

(**Note: if your machine has Apache running, you should stop it first by running `sudo service apache2 stop`.**)

```bash
docker run -dit --restart unless-stopped --name gitdox-dev -p 5000:80 gucorpling/gitdox:dev
docker run -dit --restart unless-stopped --name gitdox-dev -p 80:80 gucorpling/gitdox:dev
```

GitDox should now be running the docker container you've set up, and you may
visit `http://localhost:5000` on your machine to verify that it works. GitDox should
visit `http://localhost` on your machine to verify that it works. GitDox should
now always be running on your machine, even if you reboot it. If for some reason
you need to stop it manually, you may do so:

Expand Down Expand Up @@ -54,7 +56,7 @@ to have your GitDox folders live in your host machine's filesystem:
```bash
sudo git clone https://github.com/gucorpling/gitdox /opt/gitdox
sudo chown -R www-data:www-data /opt/gitdox
docker run -dit --restart unless-stopped --name gitdox -v /opt/gitdox:/var/www/html -p 5000:80 gucorpling/gitdox:dev gitdox
docker run -dit --restart unless-stopped --name gitdox -v /opt/gitdox:/var/www/html -p 80:80 gucorpling/gitdox:dev gitdox
```

These commands install GitDox under `/opt` in your host machine and allows you to modify them just as you would modify any other file on your machine. But in the Docker command, with the `-v` flag we tell it to mount this folder as `/var/www/html` in the container's filesystem. The files are shared bidirectionally: changes made in the container will flow to the host, and vice versa.
Expand Down
Loading

0 comments on commit eef6202

Please sign in to comment.