blob: 924a700fa059ae3be17e45d37b986c4cbe17a9ab [file]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Getting Started</title>
<meta name="description" content="This project is not currently maintained and will be refactored. If you are interested in STOUT, join the discussion on our dev list.">
<link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="/semantic/dist/semantic.min.js"></script>
<script src="https://d3js.org/d3.v4.min.js"></script>
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
<link rel="canonical" href="http://flagon.incubator.apache.org/docs/stout/start.html">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
<body>
<div class="site-header">
<div id="main-menu" class="ui inverted padded fixed top borderless menu">
<a class="site-title" href="/">
<h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
<a class="item" href="/tap">Tap</a>
<a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
<a class="item" href="/docs/stack">Stack</a>
<a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
<a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
<a class="item" href="/docs/tap">Tap</a>
<a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
<a class="item" href="/community">Community</a>
</div>
</div>
</div>
<div class="main-wrapper">
<div class="docs-wrapper">
<div class="docs-sidebar">
<!-- <div class="ui inverted list">
<a class="item" href="/docs">About the Docs</a>
</div> -->
<div id="docs-nav" class="ui inverted accordion">
<div class="title">
<i class="dropdown icon"></i>
Apache Flagon
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/">About the Docs</a>
<a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
<div class="title">
<i class="dropdown icon"></i>
Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/stack/">Getting Started</a>
<a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
<div class="title">
<i class="dropdown icon"></i>
UserALE
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/userale/">About UserALE</a>
</div>
</div>
<div class="title">
<i class="dropdown icon"></i>
UserALE.js
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/useralejs/">Getting Started</a>
<a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
<a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
<a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
<a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
<a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
<div class="title">
<i class="dropdown icon"></i>
UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/useralepy/">Installation</a>
<a class="item" href="/docs/useralepy/start.html">Getting Started</a>
<a class="item" href="/docs/useralepy/api.html">API Documentation</a>
<a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
<div class="title">
<i class="dropdown icon"></i>
Distill
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/distill/">Installation</a>
<a class="item" href="/docs/distill/start.html">Getting Started</a>
<a class="item" href="/docs/distill/api.html">API Documentation</a>
<a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
<a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
<a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
<a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
</div>
</div>
<div class="title">
<i class="dropdown icon"></i>
Tap
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/tap/">Getting Started</a>
</div>
</div>
<div class="active title">
<i class="dropdown icon"></i>
Stout
</div>
<div class="active content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/stout/">About Stout</a>
<a class="item" href="/docs/stout/start.html">Getting Started</a>
</div>
</div>
</div>
</div>
<div class="docs-content">
<h2 class="ui header">Getting Started</h2>
<h4 id="this-project-is-not-currently-maintained-and-will-be-refactored-if-you-are-interested-in-stout-join-the-discussion-on-our-dev-list">This project is not currently maintained and will be refactored. If you are interested in STOUT, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
<h3 id="getting-going">Getting Going…</h3>
<p>If you already have your own system and just want to work with the source code, then skip to the next section. Otherwise read on…</p>
<p>The simplest way to get started, rather than build your own system from the ground up, is to download both <a href="https://www.virtualbox.org">VirtualBox</a> and <a href="https://www.vagrantup.com">Vagrant</a>. Once you have both of those working, you can clone this repository to begin.</p>
<h4 id="getting-this-working-on-vagrant-virtualbox">Getting this working on Vagrant (VirtualBox)</h4>
<p>Get a base centos box (this may take awhile)</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant box add centos_6.5 https://github.com/2creatives/vagrant-centos/
releases/download/v6.5.3/centos65-x86_64-20140116.box
</code></pre></div></div>
<p>Start it</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant up virtualbox
</code></pre></div></div>
<h4 id="getting-this-working-on-vagrant-openstack">Getting this working on Vagrant (OpenStack)</h4>
<p>Get a base centos box (this may take awhile)</p>
<p>You need 2 files:</p>
<ol>
<li>
<p>The first is the <code class="highlighter-rouge">.pem</code> (or <code class="highlighter-rouge">.cer</code>) file which is the KeyPair file you can download from the OpenStack dashboard.</p>
</li>
<li>
<p>The second is a shell script which contains all the environment variables referenced in the Vagrantfile. This is located under API Access under the Security Settings. Once you download this file run <code class="highlighter-rouge">source $file.sh</code>, and this will ask you for you OpenStack password and load all the required varaibles under your current environment.</p>
</li>
</ol>
<p>Adjust the Vagrantfile to use the appropriate <code class="highlighter-rouge">.pem</code> file and the appropriate KeyPair name associated with that pem file. Once that is complete you can run:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant up openstack <span class="nt">--provider</span><span class="o">=</span>openstack
</code></pre></div></div>
<hr />
<h3 id="if-you-already-have-your-own-system">If you already have your own system…</h3>
<p>Once this package is cloned, create the database</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> python manage.py syncdb
</code></pre></div></div>
<p>This will also create a superuser.</p>
<h4 id="during-development-if-you-want-to-drop-to-the-database-and-start-over-run-the-following">During development, if you want to drop to the database and start over run the following:</h4>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> python manage.py sqlclear op_tasks | python manage.py dbshell
python manage.py syncdb
python manage.py populate_db
</code></pre></div></div>
<p>This will keep your super user and drop just the app database which is a lot nicer than deleting the whole database and starting over</p>
<p>This process is also under the <code class="highlighter-rouge">reset_optask</code> command</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> python manage.py reset_optask
</code></pre></div></div>
<hr />
<h3 id="now-that-stout-is-running">Now that STOUT is running…</h3>
<p>The following instructions assume you’re using Vagrant. If you’re using another system, you might need to alter them slightly (e.g. different IP addresses, etc.) to get the same results.</p>
<h4 id="test-operation">Test operation</h4>
<p>Open a browser and point it to <a href="http://localhost:8080">localhost:8080</a>. You should see the welcome page for the XDATA Online Experiment. The system comes with a one prepopulated example task. Register a new user and test it out.</p>
<h4 id="access-admin-page">Access admin page</h4>
<p>The Admin page allows direct access to the STOUT database. From this page you can manage users, tasks, and products directly. Before you can access the admin page, you need to create a superuser. If you’re using Vagrant you can ssh into that system using</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant ssh virtualbox
</code></pre></div></div>
<p>Navigate to the source directory and add a superuser</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nb">cd</span> /var/www/op_tasks/db/
<span class="nb">sudo </span>python manage.py createsuperuser
</code></pre></div></div>
<p>Now point your browser to the admin page at <a href="http://localhost:8080/admin">localhost:8080/admin</a> to begin browsing the STOUT database.</p>
<h4 id="add-subjects">Add subjects</h4>
<p>From the admin page, you can pre-register users through the Participants link.</p>
<h4 id="add-tasks">Add tasks</h4>
<p>You can also add new tasks for users to complete through the Op tasks link. First however you must add a dataset for the task to reference. That can be done through the Datasets link.</p>
<h4 id="add-products">Add products</h4>
<p>New products can be added through the product link. Products are tools available online. Copy and past the address for the tool into the URL field and then fill in the remaining information.</p>
<h4 id="assign-task-sequences">Assign task sequences</h4>
<p>Normally, a user is assigned a random order of tasks from all those that are available. If you’d prefer to assign a sequence of tasks though that can be managed through the TaskListItem link.</p>
<p><strong>Note:</strong> If you assign multiple tasks to a single user, only mark the first task as <strong><em>Ot active</em></strong> and leave all checkboxes for the remaining tasks empty</p>
</div>
</div>
</div>
<div class="footer ui inverted very padded vertical segment">
<div class="ui vertical segment">
<div class="ui four column grid">
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
<a class="item" href="/tap">Tap</a>
<a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
<a class="item" href="/docs/stack">Stack</a>
<a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserAle.js</a>
<a class="item" href="/docs/useralepy">UserAle.py</a>
<a class="item" href="/docs/distill">Distill</a>
<a class="item" href="/docs/tap">Tap</a>
<a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<div class="column">
<h4 class="ui inverted header">Community</h4>
<div class="ui inverted link list">
<a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
<a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
<a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
<a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
<a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
</div>
</div>
<div class="column">
<h4 class="ui inverted header">Apache</h4>
<div class="ui inverted link list">
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
<a class="item" href="http://www.apache.org/licenses/">License</a>
<a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
<a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
<a class="item" href="http://www.apache.org/security/">Security</a>
</div>
</div>
</div>
</div>
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</div>
<div class="center aligned column">
Copyright &copy; 2022 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
</div>
</div>
</div>
<div class="ui inverted vertical segment">
<div class="ui one column middle aligned grid">
<div class="center aligned column">
<a href="http://incubator.apache.org/">
<img src="/images/incubator-logo-white.jpg">
</a>&nbsp;
<a href="https://www.apache.org/events/current-event.html">
<img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
</a>
</div>
</div>
</div>
</div>
</body>
</html>