Skip to content

Commit 045a800

Browse files
committed
Clarify node.js projects deployment in docs
1 parent 3f8ae85 commit 045a800

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Exoframe is a self-hosted tool that allows simple one-command deployments using
2323
- Simple update procedure for client, server and Traefik
2424
- Optional automatic subdomain assignment (i.e. every deployment gets its own subdomain)
2525

26-
\* Traefik feature
26+
\* Feature provided by [Traefik](https://traefik.io/)
2727

2828
## Demo
2929

docs/Basics.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Basics
22

3-
### Concepts
3+
## Concepts
44

55
- **Project** - one or more deployments grouped together (e.g. started via docker-compose)
66
- **Deployment** - one and only one deployed service
@@ -18,7 +18,18 @@ Be aware though - execution of deployments will result in (1) new Docker images
1818
Depending on your project's complexity, this might require significant amount of resources during both steps resulting in failed deployments (note: if Docker goes out-of-memory during build, you will not get any specific error - just a failed deployment).
1919
It is recommended to run Exoframe on a server with at least 1GB of RAM.
2020

21-
### Commands
21+
## Supported project types
22+
23+
Currently, Exoframe understands and can deploy the following project types:
24+
25+
1. Static html based projects - will be deployed using [nginx](http://hub.docker.com/_/nginx) image
26+
2. Node.js based projects - will be deployed using [node:latest](https://hub.docker.com/_/node) image *
27+
3. Docker based project - will be deployed using your [Dockerfile](https://docs.docker.com/engine/reference/builder/)
28+
4. Docker-Compose based projects - will be deployed using your [docker-compose](https://docs.docker.com/compose/compose-file/) file
29+
30+
\* There are two things to keep in mind for Node.js projects: (1) they are started via `npm start`, so make sure you have specified start script in your `package.json`; (2) by default port 80 is exposed, so you need to make your app listen on that port. If you'd like to execute your app in any different way or expose more ports - please use Dockerfile deployment method.
31+
32+
## Commands
2233

2334
| Command | Description |
2435
| ---------------------- | ----------- |

docs/FAQ.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,16 @@
11
# FAQ
22

3-
### Is it ready for production?
3+
## Is it ready for production?
44

55
Yes. We've been using it to deploy our project since May 2017 without any issues.
66

7-
### Why do I need to enter username during login?
7+
## Why do I need to enter username during login?
88

99
Username is just your ID that is used to distinguish your deployments from others.
1010
Right now you have to enter it yourself. And you will only see deployments done with that username.
1111
Currently, more than one user can use same username (so, all users with that username will see same deployments).
1212

13-
### How does it work?
13+
## How does it work?
1414

1515
Exoframe uses [Docker](https://www.docker.com/) to deploy your project and [Traefik](https://traefik.io/) to proxy requested domains and/or paths to deployed projects.
1616
All the Docker configuration of your projects happens automatically. So after running the command, the only thing you need to do is wait a few seconds until your project have been built and deployed!
17-
18-
### What kind of projects can I deploy with Exoframe?
19-
20-
Currently, Exoframe understands and can deploy the following project types:
21-
22-
1. static html based projects - will be deployed using [nginx](http://hub.docker.com/_/nginx) image
23-
2. node.js based projects - will be deployed using [node:alpine](https://hub.docker.com/_/node) image
24-
3. docker based project - will be deployed using your [Dockerfile](https://docs.docker.com/engine/reference/builder/)
25-
4. docker-compose based project - will be deployed using your [docker-compose](https://docs.docker.com/compose/compose-file/) file
26-

docs/Links.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Articles, video and related links
22

3-
### Articles
3+
## Articles
44

55
- [Introducing Exoframe (beta) — self-hosted alternative to Now.sh](https://hackernoon.com/introducing-exoframe-beta-self-hosted-alternative-to-now-sh-80643f96b84b)
66
- [Continuous deployment for your Node.js projects in 10 minutes with Exoframe](https://hackernoon.com/continuous-deployment-for-your-node-js-projects-in-10-minutes-with-exoframe-bdf48340c1be)
77
- [Simplifying Docker management with Exoframe](https://hackernoon.com/simplifying-docker-management-with-exoframe-9275e92c7406)
88

9-
### Videos
9+
## Videos
1010

1111
- [Introducing Exoframe - self-hosted Now.sh alternative](https://www.youtube.com/watch?v=VZnYKIoh5oA)
1212
- [Continuous Deployment for Node.js projects in 10 mins using Exoframe](https://www.youtube.com/watch?v=AEwLt5hmKYo)

0 commit comments

Comments
 (0)