Skip to content

Commit

Permalink
readme improved, some informations added
Browse files Browse the repository at this point in the history
  • Loading branch information
fridolinsiegmund committed Dec 2, 2018
1 parent 4341aea commit 33664ce
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Run
```
./start.sh
```
to start MACI.
to start MACI. In some cases it can be useful to launch the script as sudo.

### Manual Installation

Expand All @@ -29,6 +29,8 @@ We do not provide an install script for Windows. You might want to manually exec
MACI is self-explaining and provides a web interface at http://<SERVER_IP>:63658 (e.g., [http://localhost:63658](http://localhost:63658)).
Check the web interface for more information.

To access Jupyter outside of localhost, you need to execute "jupyter notebook --ip <SERVER_IP> --port 8888" on the machine, where the start script is running.

## Contribute

We are happy for all kind of contributions, including bug fixes and additional features.
Expand All @@ -39,4 +41,4 @@ Design and Concepts: [@AlexanderFroemmgen](https://github.com/AlexanderFroemmgen

Implementation: [@AlexanderFroemmgen](https://github.com/AlexanderFroemmgen), [@a10r](https://github.com/a10r), [@max-weller](https://github.com/max-weller)

Fixes and Minor Features: [@RolandKluge](https://github.com/RolandKluge), [@ckleemann](https://github.com/ckleemann), [@Nikolasel](https://github.com/Nikolasel), [@martinpfannemueller](https://github.com/martinpfannemueller), [@dstohr](https://github.com/dstohr), [@rhaban](https://github.com/rhaban), [@IstEchtSo](https://github.com/IstEchtSo)
Fixes and Minor Features: [@RolandKluge](https://github.com/RolandKluge), [@ckleemann](https://github.com/ckleemann), [@Nikolasel](https://github.com/Nikolasel), [@martinpfannemueller](https://github.com/martinpfannemueller), [@dstohr](https://github.com/dstohr), [@rhaban](https://github.com/rhaban), [@IstEchtSo](https://github.com/IstEchtSo)
2 changes: 1 addition & 1 deletion maci_backend/AppData/WorkerScript/worker.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ def executeJob(uri, job_location):
print "posting file failed"
log_content += '\n---\nPosting file failed'
except:
print "posting files failed"
print "no binary files sent to server"
log_content += '\n---\nPosting files failed.'

# handle experiment results and messages
Expand Down
6 changes: 3 additions & 3 deletions maci_backend/webcontent/views/workerhosts/host_list.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ <h4>Configuration</h4>
<h2>Manual management</h2>
<p>Alternatives:</p>
<ul>
<li><a ng-href="workers/bootstrap.sh">Download</a> the bootstrap script to manually bootstrap (install and start) new worker instances (recommended).</li>
<li><a ng-href="workers/script.py">Download</a> the worker script to manually start worker, e.g., use <code>python -u script.py --backend {{backend}} --capabilities replaceIfRequired</code> to manually call an existing worker script.</li>
<li><a ng-href="workers/bootstrap.sh">Download</a> the bootstrap script to manually bootstrap (install and start) new worker instances (recommended). Watch out for the shutdown command, which is required to shut down AWS instances.</li>
<li><a ng-href="workers/script.py">Download</a> the worker script to manually start worker, e.g., use <code>python -u script.py --backend {{backend}} --capabilities replaceIfRequired</code> to manually call an existing worker script. You need to replace the "replaceIfRequired" field with your requiered capabilities, e.g. mininet</li>
</ul>
<p ng-show="warning_backend_localhost" style="color:red">It seems the backend is running on the localhost. Automatic detection of the backend IP failed. Please specify the correct backend location in the bootstrap script and when starting the worker.</p>

Expand Down Expand Up @@ -113,4 +113,4 @@ <h4>Setting up your AWS account and importing images as AMI</h4>
<h2>Security Considerations</h2>
<p>You should make sure that your MACI instance is accessible from the workers. We recommend to use security groups in the AWS firewall, e.g., as described <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html#adding-security-group-rule">here</a>.
Just add a security group to all launched workers (specify it in the appsettings.json) and add a rule to your MACI instance allowing incoming traffic on port 63658 for this group.</p>
</div>
</div>

0 comments on commit 33664ce

Please sign in to comment.