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

Update docs on Docker's registry mirrors #511

Merged
merged 6 commits into from
Jun 26, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
fix backticks and expression
  • Loading branch information
amber-moe committed Jun 12, 2019
commit 2155b5dcb0fa831f8e3d7bb10e923eb4115eac0d
36 changes: 36 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Nebula docs
---

**Nebula** is a distributed, scalable, lightning-fast graph database. It is the only solution in the world capable to host graphs with dozens of billions of vertices (nodes) and trillions of edges, while still provides millisecond latency.

**Nebula's** goal is to provide reading, writing, and computing with high concurrency, low latency for super large scale graphs. Nebula is an open source project and we are looking forward to working with the community to popularize and promote the graph database.

As a graph database, **Nebula** has these features
* Symmetrically distributed
* Highly scalable
* Fault tolerant
* Strong data consistency
* SQL-like query language

## How can I get Nebula ##
**Nebula** source code is available here on [`GitHub`](https://github.com/vesoft-inc/nebula). The currently release is version 0.1. Please refer the `Release Notes` here for details. You can also download [`docker` ](https://www.docker.com/get-started)image to try it.
More details on how to get Nebula image click [`Get Started`](https://github.com/vesoft-inc/nebula/blob/master/docs/get-started.md).

## How can I contribute ##
As the team behind **Nebula**, we fully commit to the community and all-in to the open source project. All the core features are and will be implemented in the open source repository.

We also encourage the community to involve the project. There are a few ways you can contribute:

* You can download and try **Nebula**, and provide us feedbacks
* You can submit your feature requirements and bug reports
* You can perfectionate documentations
* You can fix bugs or implement features. More details on how to build the project and submit the Pull Requests click [`how-to-contribute`](https://github.com/vesoft-inc/nebula/blob/master/docs/how-to-contribute.md).

## Licensing ###
**Nebula** is under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license, so you can freely download, modify, deploy the source code to meet your needs. You can also freely deploy **Nebula** as a back-end service to support your SAAS deployment.

In order to prevent cloud providers monetarizing from the project without contributing back, we added [Common Clause 1.0](https://commonsclause.com/) to the project. As mentioned above, we fully commit to the open source community. We would love to hear your thoughts on the licensing model and are willing to make it more suitable for the community.

## Contact
- Please use [`GitHub issue tracker`](https://github.com/vesoft-inc/nebula/issues) for filling bugs or feature requests.
- Join [![](https://img.shields.io/badge/slack-nebula-519dd9.svg)](https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200).
16 changes: 8 additions & 8 deletions docs/get-started.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@

---

This tutorial provides a quick introduction to use `Nebula Graph`.
This tutorial provides a quick introduction to use Nebula Graph.

---

### Step 1 Install Nebula Graph

The easiest way to startup `Nebula` is using `Docker`.
`Docker` is a tool designed to make it easier to create, deploy, and run applications by using containers.
The easiest way to startup Nebula is using Docker.
Docker is a tool designed to make it easier to create, deploy, and run applications by using containers.
Containers allow a developer to package up an application with all of the parts it needs,
such as libraries and other dependencies, and ship it all out as one package.
By doing so, the developer can rest assured that the application will run on any other `Linux` machine regardless of any customized settings that machine might have that could differ from the machine used for writing and testing the code.
By doing so, the developer can rest assured that the application will run on any other Linux machine regardless of any customized settings that machine might have that could differ from the machine used for writing and testing the code.

First of all, you should make sure that `Docker` has been installed on your machine. Open a terminal and run the following command :
First of all, you should make sure that Docker has been installed on your machine. Open a terminal and run the following command :

```
docker --version
```

If `Docker` is not found, please see [here](https://docs.docker.com/install/) for more information to install Docker.
If Docker is not found, please see [here](https://docs.docker.com/install/) for more information to install Docker.

After that, using
```
docker pull vesoft/nebula-graph:latest
```
to get `Nebula` image and `Docker images` that can display images status.
to get `nebula` image and `docker images` that can display images status.

If `Docker` is slow when pulling the image, configure a new mirror.
If the pulling is slow when pulling the image, configure a new mirror.
1. Check if the `/etc/docker` folder exists, if not, create a new one with `mkdir -p /etc/docker`. Generally the folder will exist after Docker installation.
2. Create the new file `daemon.json` with the following command

Expand Down