-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove Docker support (until, or if ever, we convert to docker-compose)
- Loading branch information
1 parent
aed7810
commit f810358
Showing
5 changed files
with
25 additions
and
218 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,123 +28,27 @@ Core Modules | |
Installation | ||
------------ | ||
|
||
Aquameta can be installed either via Docker, on an Amazon Ubuntu 16.04 EC2 instance, or from source on your local machine. | ||
Aquameta is designed for installation on a Ubuntu 18.04 instance. Aquameta installs a number of `apt` packages. It works best on a clean install of Ubuntu. We recommend using a KVM instance, or Amazon EC2 instance. | ||
|
||
### Docker | ||
1. `git clone https://github.com/aquametalabs/aquameta.git` | ||
2. `cd aquameta` | ||
3. `./install.sh` | ||
|
||
To install via Docker, the easiest way is to just pull down the latest image from Docker Hub: | ||
From the installer, follow the instructions. | ||
|
||
``` | ||
docker pull aquametalabs/aquameta:0.2.0-rc2 | ||
``` | ||
|
||
Alternately, you can clone the Aquameta git repository and build your own Docker image (which takes about 15 minutes): | ||
|
||
``` | ||
git clone https://github.com/aquametalabs/aquameta.git | ||
cd aquameta/ | ||
docker build -t aquametalabs/aquameta . | ||
``` | ||
|
||
Once you've either pulled or built a Aquameta image, run the container to start it up: | ||
|
||
``` | ||
docker run -dit -p 80:80 -p 5432:5432 --privileged aquametalabs/aquameta:0.2.0-rc2 | ||
``` | ||
|
||
If you wish to use alternate ports, they can be changed in the `docker run` command. | ||
|
||
``` | ||
# run the Aquameta webserver on port 8080, and the PostgreSQL server on port 5433 | ||
sudo docker run -dit -p 8080:80 -p 5433:5432 --privileged aquametalabs/aquameta:0.2.0-rc2 | ||
``` | ||
|
||
Make a note of the container-id that this command outputs. You can use it to | ||
restart the container later, if you restart your computer, to get your data back. | ||
|
||
Once Aquameta is running, browse to `http://localhost/dev` (or whatever | ||
host/port it is installed on) to access the web-based IDE. To access the | ||
PostgreSQL database, use `psql -p 5432 aquameta`. | ||
|
||
Aquameta uses the "long-running container" pattern instead of exporting volumes | ||
at this time, so if you stop the container, just restart it with `docker | ||
restart {container_id}`. | ||
|
||
|
||
### Amazon EC2 | ||
|
||
To install Amazon on Amazon, follow these steps: | ||
|
||
1. Create a new EC2 instance, running Ubuntu 16.04 | ||
2. ssh into your instance with `ssh -i {your_pem_file.pem} ubuntu@{your_ip}` | ||
3. `git clone https://github.com/aquametalabs/aquameta.git` | ||
4. `sudo mkdir /s` | ||
5. `mv ./aquameta /s/aquameta` | ||
6. `cd /s/aquameta` | ||
7. `./install.sh` | ||
|
||
From the installer, follow the instructions. If prompted for any LOCALE settings, just hit OK. | ||
|
||
Once the installer completes, you'll have a instance of Aquameta running. | ||
|
||
### From Source (Advanced) | ||
|
||
To install Aquameta from source, follow the steps in the | ||
[install.sh](https://github.com/aquametalabs/aquameta/blob/master/install.sh) | ||
script. The script is designed to run on an Ubuntu 16.04 server, and will | ||
require some adaptation for different environments. | ||
|
||
Getting Started | ||
--------------- | ||
|
||
Once you have Aquameta running, create a superuser and then you can start building applications. | ||
|
||
### Create a Superuser | ||
|
||
To setup a user, from a shell prompt, open up a database shell with: | ||
|
||
``` | ||
$ psql aquameta | ||
psql (9.6.9) | ||
Type "help" for help. | ||
aquameta=# select endpoint.register('[email protected]'); | ||
``` | ||
|
||
You'll be sent a confirmation code to the email specified. Check your email and copy the code. CHECK YOUR SPAM FOLDER! | ||
|
||
Then confirm the user registration and make the user a PostgreSQL superuser: | ||
|
||
``` | ||
aquameta=# select endpoint.register_confirm('[email protected]', '{your confirmation code}'); | ||
aquameta=# select endpoint.superuser('[email protected]'); | ||
``` | ||
|
||
You now have a superuser. Browse to http://{your_ip}/login to sign in. | ||
|
||
### Starting Development | ||
|
||
The primary development interface lives at http://{your_ip}/dev. From here you can create bundles and edit their contents. To find out more about how to develop apps in Aquameta, here are the available resources: | ||
|
||
- [Quickstart](docs/quickstart.md) | ||
- [Cheat Sheet](docs/cheatsheet.md) | ||
|
||
Development | ||
----------- | ||
|
||
The primary development interface lives at http://{your_ip}/dev. From here you can create bundles and edit their contents. For more information, see the [documentation](docs/). | ||
|
||
Contribute | ||
---------- | ||
|
||
- Source Code: [github.com/aquametalabs/aquameta](https://github.com/aquametalabs/aquameta) | ||
- Issue Tracker: [github.com/aquametalabs/aquameta/issues](https://github.com/aquametalabs/aquameta/issues) | ||
- IRC Channel: `#aquameta` on `irc.freenode.net` | ||
|
||
Support | ||
------- | ||
|
||
If you are having issues, please let us know. | ||
We have a mailing list located at: [email protected] | ||
|
||
License | ||
------- | ||
|
||
The project is licensed under the GPL. | ||
The project is licensed under the GPL 3.0. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters