update documentation
This commit is contained in:
Sam
parent
1f3fe5d07f
commit
4b03a66117
@ -269,19 +269,12 @@ For instance, copy and update ``.env`` file from ``.env.example`` and source the
|
||||
$ nano .env
|
||||
$ source .env
|
||||
|
||||
|
||||
- Upgrade database schema
|
||||
- Initialize database schema
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ fittrackee_upgrade_db
|
||||
|
||||
- Initialize database
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ fittrackee_init_data
|
||||
|
||||
- Start the application
|
||||
|
||||
.. code-block:: bash
|
||||
@ -297,6 +290,14 @@ For instance, copy and update ``.env`` file from ``.env.example`` and source the
|
||||
.. note::
|
||||
| To start application and workers with **systemd** service, see `Deployment <installation.html#deployment>`__
|
||||
|
||||
- Open http://localhost:3000 and register
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ fittrackee_set_admin <username>
|
||||
|
||||
|
||||
From sources
|
||||
^^^^^^^^^^^^
|
||||
@ -349,8 +350,13 @@ Dev environment
|
||||
|
||||
$ make run-workers
|
||||
|
||||
Open http://localhost:3000 and log in (the email is ``admin@example.com``
|
||||
and the password ``mpwoadmin``) or register
|
||||
- Open http://localhost:3000 and register
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ make set-admin USERNAME=<username>
|
||||
|
||||
|
||||
Production environment
|
||||
@ -390,9 +396,13 @@ Production environment
|
||||
|
||||
$ make run
|
||||
|
||||
Open http://localhost:5000, log in as admin (the email is
|
||||
``admin@example.com`` and the password ``mpwoadmin``) and change the
|
||||
password
|
||||
- Open http://localhost:5000 and register
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ make set-admin USERNAME=<username>
|
||||
|
||||
|
||||
Upgrade
|
||||
@ -642,10 +652,16 @@ installing **FitTrackee** from **sources**.
|
||||
$ cd FitTrackee
|
||||
$ make docker-build docker-run docker-init
|
||||
|
||||
Open http://localhost:5000, log in as admin (the email is `admin@example.com` and the password `mpwoadmin`) or register.
|
||||
Open http://localhost:5000 and register.
|
||||
|
||||
Open http://localhost:8025 to access `MailHog interface <https://github.com/mailhog/MailHog>`_ (email testing tool)
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ make docker-set-admin USERNAME=<username>
|
||||
|
||||
- To stop **Fittrackee**:
|
||||
|
||||
.. code-block:: bash
|
||||
@ -683,8 +699,7 @@ Development
|
||||
|
||||
$ make docker-serve-client
|
||||
|
||||
Open http://localhost:3000 and log in (the email is ``admin@example.com``
|
||||
and the password ``mpwoadmin``) or register
|
||||
Open http://localhost:3000
|
||||
|
||||
.. note::
|
||||
Some environment variables need to be updated like `UI_URL`
|
||||
@ -527,18 +527,12 @@ $ <span class="nb">source</span> .env
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>Upgrade database schema</p></li>
|
||||
<li><p>Initialize database schema</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ fittrackee_upgrade_db
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>Initialize database</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ fittrackee_init_data
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>Start the application</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ fittrackee
|
||||
@ -556,6 +550,13 @@ $ <span class="nb">source</span> .env
|
||||
<div class="line">To start application and workers with <strong>systemd</strong> service, see <a class="reference external" href="installation.html#deployment">Deployment</a></div>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and register</p></li>
|
||||
<li><p>To set admin rights to the newly created account, use the following command:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ fittrackee_set_admin <username>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="from-sources">
|
||||
<h3>From sources<a class="headerlink" href="#from-sources" title="Permalink to this headline">¶</a></h3>
|
||||
@ -606,8 +607,13 @@ $ make install-db
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run-workers
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and log in (the email is <code class="docutils literal notranslate"><span class="pre">admin@example.com</span></code>
|
||||
and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) or register</p>
|
||||
<ul class="simple">
|
||||
<li><p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and register</p></li>
|
||||
<li><p>To set admin rights to the newly created account, use the following command:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make set-admin <span class="nv">USERNAME</span><span class="o">=</span><username>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="production-environment">
|
||||
<h4>Production environment<a class="headerlink" href="#production-environment" title="Permalink to this headline">¶</a></h4>
|
||||
@ -647,9 +653,13 @@ database credentials</strong>):</p></li>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Open <a class="reference external" href="http://localhost:5000">http://localhost:5000</a>, log in as admin (the email is
|
||||
<code class="docutils literal notranslate"><span class="pre">admin@example.com</span></code> and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) and change the
|
||||
password</p>
|
||||
<ul class="simple">
|
||||
<li><p>Open <a class="reference external" href="http://localhost:5000">http://localhost:5000</a> and register</p></li>
|
||||
<li><p>To set admin rights to the newly created account, use the following command:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make set-admin <span class="nv">USERNAME</span><span class="o">=</span><username>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
@ -892,9 +902,15 @@ $ <span class="nb">cd</span> FitTrackee
|
||||
$ make docker-build docker-run docker-init
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Open <a class="reference external" href="http://localhost:5000">http://localhost:5000</a>, log in as admin (the email is <cite>admin@example.com</cite> and the password <cite>mpwoadmin</cite>) or register.</p>
|
||||
<p>Open <a class="reference external" href="http://localhost:5000">http://localhost:5000</a> and register.</p>
|
||||
<p>Open <a class="reference external" href="http://localhost:8025">http://localhost:8025</a> to access <a class="reference external" href="https://github.com/mailhog/MailHog">MailHog interface</a> (email testing tool)</p>
|
||||
<ul class="simple">
|
||||
<li><p>To set admin rights to the newly created account, use the following command:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make docker-set-admin <span class="nv">USERNAME</span><span class="o">=</span><username>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>To stop <strong>Fittrackee</strong>:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make docker-stop
|
||||
@ -930,8 +946,7 @@ $ make docker-build docker-run docker-init
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make docker-serve-client
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and log in (the email is <code class="docutils literal notranslate"><span class="pre">admin@example.com</span></code>
|
||||
and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) or register</p>
|
||||
<p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a></p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Some environment variables need to be updated like <cite>UI_URL</cite></p>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -269,19 +269,12 @@ For instance, copy and update ``.env`` file from ``.env.example`` and source the
|
||||
$ nano .env
|
||||
$ source .env
|
||||
|
||||
|
||||
- Upgrade database schema
|
||||
- Initialize database schema
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ fittrackee_upgrade_db
|
||||
|
||||
- Initialize database
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ fittrackee_init_data
|
||||
|
||||
- Start the application
|
||||
|
||||
.. code-block:: bash
|
||||
@ -297,6 +290,14 @@ For instance, copy and update ``.env`` file from ``.env.example`` and source the
|
||||
.. note::
|
||||
| To start application and workers with **systemd** service, see `Deployment <installation.html#deployment>`__
|
||||
|
||||
- Open http://localhost:3000 and register
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ fittrackee_set_admin <username>
|
||||
|
||||
|
||||
From sources
|
||||
^^^^^^^^^^^^
|
||||
@ -349,8 +350,13 @@ Dev environment
|
||||
|
||||
$ make run-workers
|
||||
|
||||
Open http://localhost:3000 and log in (the email is ``admin@example.com``
|
||||
and the password ``mpwoadmin``) or register
|
||||
- Open http://localhost:3000 and register
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ make set-admin USERNAME=<username>
|
||||
|
||||
|
||||
Production environment
|
||||
@ -390,9 +396,13 @@ Production environment
|
||||
|
||||
$ make run
|
||||
|
||||
Open http://localhost:5000, log in as admin (the email is
|
||||
``admin@example.com`` and the password ``mpwoadmin``) and change the
|
||||
password
|
||||
- Open http://localhost:5000 and register
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ make set-admin USERNAME=<username>
|
||||
|
||||
|
||||
Upgrade
|
||||
@ -642,10 +652,16 @@ installing **FitTrackee** from **sources**.
|
||||
$ cd FitTrackee
|
||||
$ make docker-build docker-run docker-init
|
||||
|
||||
Open http://localhost:5000, log in as admin (the email is `admin@example.com` and the password `mpwoadmin`) or register.
|
||||
Open http://localhost:5000 and register.
|
||||
|
||||
Open http://localhost:8025 to access `MailHog interface <https://github.com/mailhog/MailHog>`_ (email testing tool)
|
||||
|
||||
- To set admin rights to the newly created account, use the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ make docker-set-admin USERNAME=<username>
|
||||
|
||||
- To stop **Fittrackee**:
|
||||
|
||||
.. code-block:: bash
|
||||
@ -683,8 +699,7 @@ Development
|
||||
|
||||
$ make docker-serve-client
|
||||
|
||||
Open http://localhost:3000 and log in (the email is ``admin@example.com``
|
||||
and the password ``mpwoadmin``) or register
|
||||
Open http://localhost:3000
|
||||
|
||||
.. note::
|
||||
Some environment variables need to be updated like `UI_URL`
|
||||
Loading…
Reference in New Issue
Block a user