Skip to content
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.

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

Added instructions on deploying a build to a webserver #322

Merged
merged 2 commits into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
** xref:user-guide/faq.adoc[FAQ]
* xref:developer-guide/index.adoc[Developer Guide]
** xref:developer-guide/build-and-run.adoc[Build & Run]
** xref:developer-guide/deploy-a-build.adoc[Deploy a Build]
** xref:developer-guide/configuration.adoc[Configuration]
** xref:developer-guide/standalone-mode.adoc[Standalone Mode]
** xref:developer-guide/component-overview.adoc[Component Overview]
Expand Down
41 changes: 41 additions & 0 deletions docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
= Deploy a Build
If you have a pre-built NeoDash application, you can easily deploy it on an any webserver.
A NeoDash build is "just" a collection of HTML, CSS and JavaScript files, so it can run virtually anywhere.

This guide walks you through the process of deploying a NeoDash build onto your own webserver.

== 1. Prepare the files
First, check that you have the correct files.
We typically provide builds as either a zip file or tarball with the following naming convention:
`neodash-2.X.X.zip` or `neodash-2.X.X.tar.gz`.

For zip files, open up the terminal and run:
```bash
unzip neodash-2.X.X.zip
```

For tar.gz files, open up the terminal and run:
```bash
tar -xf neodash-2.X.X.tar.gz
```

After running either of these, you should now have a folder `neodash-2.X.X` in the current directory.

== 2. Edit Configuration (Optional)
This is an optional step if you want to configure optional settings for your NeoDash deployment (e.g. SSO or standalone mode).

1. Inside the folder you just unzipped, open up `config.json`.
2. Edit this file to modify your link:../configuration[Configuration] settings.
3. Save the file.

== 3. Move the tarball/zip to your webserver
Finally, copy the files to the correct folder on your webserver.
Depending on the webserver type and version, this could be different directory.
As an example - to copy the files to an nginx webserver using `scp`:

```bash
scp neodash-2.2.1 username@host:/usr/share/nginx/html
```

NeoDash should now be visible by visiting your (sub)domain in the browser.
Can't see the application? Check that the webserver user has read-permissions on the files you copied into the HTML directory.