Skip to content

Documentation: Expand on installing under Docker #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andybeak wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Documentation: Expand on installing under Docker #453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions website/source/install.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ header: Install
%>

<div id="docker" class="platform-download" style="display: none;">
<p>In this simple example, custom API Umbrella configuration can be defined in the <code>config/api-umbrella.yml</code> file on host machine. This gets mounted as <code>/etc/api-umbrella/api-umbrella.yml</code> inside the container, which is the path for the configuration file the rest of the documentation will reference.</p>
<p>In this simple example, custom API Umbrella configuration can be defined in the <code>config/api-umbrella.yml</code> file on host machine. This gets mounted as <code>/etc/api-umbrella/api-umbrella.yml</code> inside the container, which is the path for the configuration file the rest of the documentation will reference. The database configuration is found in the <code>/opt/api-umbrella/var/db directory</code>, which in the example below is mounted into the "db" directory. Note that this example is not suitable for persisting changes made to the frontend site and
is just a quickstart example.</p>

<pre>$ mkdir config && touch config/api-umbrella.yml
$ docker run -d --name=api-umbrella -p 80:80 -p 443:443 -v "$(pwd)/config":/etc/api-umbrella nrel/api-umbrella</pre>
$ docker run -d --name=api-umbrella -p 80:80 -p 443:443 -v "$(pwd)/config":/etc/api-umbrella -v "$(pwd)/db":/opt/api-umbrella/var/db -v "$(pwd)/log":/opt/api-umbrella/var/log nrel/api-umbrella</pre>
</div>

<% packages.each do |id, distro| %>
Expand Down