Skip to content

Commit

Permalink
readme tweaks, tagged v1.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
marius311 committed Jul 29, 2017
1 parent ccfe9a9 commit b4d09a6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ docker-compose pull
docker-compose up -d
```

*Windows/Mac/docker-machine:* You will also need to run `sudo ssh docker@$(docker-machine ip) -L 80:localhost:80 -N` and enter `tcuser` when prompted for a password.
On Windows, Mac, or Linux if running Docker via docker-machine instead of natively, you will also need to run `ssh docker@$(docker-machine ip) -L 80:localhost:80 -N` and enter `tcuser` when prompted for a password (on Mac/Linux, this command needs to be run with `sudo`).

You can now visit the server webpage and connect clients to the server at http://127.0.0.1/boincserver.

Expand All @@ -55,6 +55,13 @@ If your job has output files, have the container write them in `/root/shared/res

This is a simple example, but any Docker containers with arbitrary code installed inside of them will work!

To stop the server and delete all server and database files (for example, if you want to start over with a fresh copy), run,

```
docker-compose down -v
```


Finally, `boinc-server-docker` is not just useful to get a simple test server running, its actually meant to run your real server. To learn how to, read the [project cookbook](https://github.com/marius311/boinc-server-docker/blob/master/docs/cookbook.md), or look at the [Cosmology@Home](https://www.github.com/marius311/cosmohome) source code as an example (`boinc-server-docker` was in fact originally developed for Cosmology@Home).

Happy crunching!
Expand All @@ -63,13 +70,13 @@ Happy crunching!
News
----

* July 26, 2017
* **Version 1.4.1** - July 26, 2017
* The default server URL is now `http://127.0.0.1/boincserver` rather than previously when it was `http://boincserver.com/boincserver`. This removes the need to edit your `/etc/hosts` file on Linux, and on Windows/Mac/docker-machine replaces having to edit `/etc/hosts` with the SSH tunnel command above. *Related warning: the boincserver.com domain is currently being squatted, so if you're using the old version be careful that you do not type sensitive information into the server website thinking you're interacting with your local test server when in fact it's a remote server at the squatted domain.*
* Updated docker-compose requirement from 1.6.0 to 1.7.0
* For Windows/Mac, updated Docker Toolbox requirement from 1.10.0 to 1.11.0
* Updated docker-compose requirement from 1.6.0 to 1.7.0, and on Windows/Mac, updated Docker Toolbox requirement from 1.10.0 to 1.11.0
* A number of improvements to boinc2docker (see [ccfe9a9](https://github.com/marius311/boinc-server-docker/commit/ccfe9a9704b9282f528565c74e07ee3be698aa0d)).


Developement and Contributing
Development and Contributing
-----------------------------

To modify and rebuild any of the `boinc-server-docker` images, you will need this git repository's submodules checked out (run `git submodule update --init --recursive`, or clone with `git clone --recursive` in the first place). Note also that currently building the images only works on Linux.
Expand Down
4 changes: 2 additions & 2 deletions docs/cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ BOINC servers have their URL hardcoded, and will not function correctly unless t
If you're are running `docker` via `docker-machine` (like on Mac or Windows), then `docker` is actually running inside a VM and the server is attached to the VM's network interface, not localhost. You can forward the necessary port on localhost to the VM with the following commmand:

```
sudo ssh docker@$(docker-machine ip) -L 80:localhost:80 -N
ssh docker@$(docker-machine ip) -L 80:localhost:80 -N
```

(when prompted, the password is `tcuser`). The fowarding will be active until you interrupt the above command.
(when prompted, the password is `tcuser`; also, if you're doing this on Mac/Linux you probably need to run this with `sudo`). The forwarding will be active until you interrupt the above command.

If you are running the server somewhere remotely, you will have to set up the necessary extra port forwarding manually, or alternatively you can change the server URL from the default to the one at which the remote server is accessible.

Expand Down

0 comments on commit b4d09a6

Please sign in to comment.