Skip to content
This repository was archived by the owner on Nov 23, 2022. It is now read-only.

Commit d95ab1a

Browse files
committed
Merge branch 'develop', prepare 1.0.0
2 parents 6fbfd46 + 2a29c9b commit d95ab1a

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

README.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
1-
# Exoframe Server (beta)
1+
# Exoframe Server
22

3-
> Power armor for docker containers
3+
> Simple Docker deployment tool
44
55
[![Build Status](https://travis-ci.org/exoframejs/exoframe-server.svg?branch=master)](https://travis-ci.org/exoframejs/exoframe-server)
66
[![Coverage Status](https://coveralls.io/repos/github/exoframejs/exoframe-server/badge.svg?branch=master)](https://coveralls.io/github/exoframejs/exoframe-server?branch=master)
77
[![Docker Pulls](https://img.shields.io/docker/pulls/exoframe/server.svg)](https://hub.docker.com/r/exoframe/server/)
88
[![Docker image size](https://images.microbadger.com/badges/image/exoframe/server.svg)](https://microbadger.com/images/exoframe/server)
99
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT)
1010

11-
## How it works
12-
13-
Exoframe intends to do all the heavy lifting required to build and deploy web services for you.
14-
To run it you need two parts - [Exoframe CLI](https://github.com/exoframejs/exoframe) and Exoframe server.
15-
16-
Exoframe automatically detects your project type, builds and deploys it to the server using [Docker](https://www.docker.com/) and [Traefik](https://github.com/containous/traefik).
17-
After running exoframe, the only thing you need to do is wait a few seconds until your files have been built or deployed!
18-
19-
[Read more about Exoframe and how it works in the main repo](https://github.com/exoframejs/exoframe).
11+
Exoframe is a self-hosted tool that allows simple one-command deployments using Docker.
2012

2113
## Installation and Usage
2214

@@ -58,12 +50,12 @@ docker run -d \
5850

5951
3. Edit config file to fit your needs (see section below)
6052

61-
Then grab [Exoframe CLI](https://github.com/exoframejs/exoframe), point it to your new Exoframe server and use it.
53+
Then install [Exoframe CLI](https://github.com/exoframejs/exoframe), point it to your new Exoframe server and use it.
6254

6355
## Configuration
6456

6557
Exoframe stores its config in `~/.exoframe/server.config.yml`.
66-
Currently it contains list of users for basic auth, debug and letsencrypt settings:
58+
Currently it contains the following settings:
6759

6860
```yaml
6961
debug: false # whether debug mode is enabled, default "false"
@@ -76,14 +68,9 @@ publicKeysPath: '/path/to/your/public/keys' # path to folder with authorized_key
7668
7769
*Warning:* Most changes to config are applied immediately. With exception of Letsencrypt config. If you are enabling letsencrypt after Traefik instance has been started, you'll need to remove Traefik and then restart Exoframe server for changes to take effect.
7870
79-
## Contribute
80-
81-
1. Fork this repository to your own GitHub account and then clone it to your local device.
82-
2. Install dependencies: `yarn`
83-
3. Execute tests to make sure everything's working: `yarn test`
84-
4. Start the server: `yarn start`
71+
## Docs
8572
86-
Now can point your Exoframe CLI to `http://localhost:8080` and use it.
73+
[Read more about Exoframe and how it works in the main repo](https://github.com/exoframejs/exoframe).
8774
8875
## License
8976

0 commit comments

Comments
 (0)