You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@age.apache.org by jo...@apache.org on 2022/10/26 04:15:56 UTC
[age-website] branch developer-manual updated (e2dce1e -> 548358e)
This is an automated email from the ASF dual-hosted git repository.
joshinnis pushed a change to branch developer-manual
in repository https://gitbox.apache.org/repos/asf/age-website.git
from e2dce1e fix some typos (#97)
new 2677677 Add Setup to Developer Manual
new 1058fdf Removed the Docker Instructions from the Developer Manual
new 548358e Merge branch 'developer-manual' of https://github.com/apache/age-website into developer-manual
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/index.rst | 2 +-
docs/intro/setup.md | 149 ++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 150 insertions(+), 1 deletion(-)
create mode 100644 docs/intro/setup.md
[age-website] 01/03: Add Setup to Developer Manual
Posted by jo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
joshinnis pushed a commit to branch developer-manual
in repository https://gitbox.apache.org/repos/asf/age-website.git
commit 267767709ea0b40e61a7d7f986c66592ab09403d
Author: Josh Innis <Jo...@gmail.com>
AuthorDate: Wed Oct 26 13:09:59 2022 +0900
Add Setup to Developer Manual
---
docs/index.rst | 2 +-
docs/intro/setup.md | 186 ++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 187 insertions(+), 1 deletion(-)
diff --git a/docs/index.rst b/docs/index.rst
index b5f8a0a..49efe91 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,7 +7,7 @@ Apache AGE's documentation
:maxdepth: 1
intro/overview
-
+ intro/setup
.. toctree::
:caption: Postgres Internals
diff --git a/docs/intro/setup.md b/docs/intro/setup.md
new file mode 100644
index 0000000..eb67d80
--- /dev/null
+++ b/docs/intro/setup.md
@@ -0,0 +1,186 @@
+# Setup
+
+## Getting AGE
+
+### Releases
+
+The releases and release notes can be found at <https://github.com/apache/age/releases>
+
+### Source code
+
+The source code can be found at <https://github.com/apache/age>
+
+## Installing From Source Code
+
+### Pre-Installation
+
+Install the following essential libraries according to each OS.
+Building AGE from source depends on the following Linux libraries (Ubuntu package names shown below):
+
+#### CentOS
+
+```console
+yum install gcc glibc glib-common readline readline-devel zlib zlib-devel flex bison
+```
+
+#### Fedora
+
+```console
+dnf install gcc glibc bison flex readline readline-devel zlib zlib-devel
+```
+
+#### Ubuntu
+
+```console
+sudo apt-get install build-essential libreadline-dev zlib1g-dev flex bison
+```
+
+### Install Postgres
+
+You will need to install a AGE compatible version of Postgres, for now AGE only supports Postgres 11 and 12.
+
+#### Install From Source Code
+
+You can <a href='https://www.postgresql.org/download/'>download the Postgres source code</a> and install your own instance of Postgres. You can read instructions on how to install from <a href='https://www.postgresql.org/docs/11/installation.html'>source code on the offical Postgres Website</a>
+
+#### Install From a Package Manager
+
+You can use a package management that your OS provides to download AGE.
+
+#### Ubuntu
+
+##### Postgres 11
+
+```
+sudo apt install postgresql-server-dev-11
+```
+
+##### Postgres 12
+```
+sudo apt install postgresql-12
+```
+
+### Installation
+
+Clone the <a href='https://github.com/apache/age'>github repository</a> or <a href='https://github.com/apache/age/releases'>download an official release</a>
+
+Run the pg_config utility and check the version of PostgreSQL, currently only PostgreSQL versions 11 & 12 are supported. If you have any other version of postgres, you will need to install PostgreSQL version 11 & 12. Follow Setting up multiple versions of PostgreSQL
+```console
+pg_config
+```
+
+The build process will attempt to use the first path in the PATH environment variable when installing AGE. If the pg_config path is located there, run the following command in the source code directory of Apache AGE to build and install the extension.
+
+```console
+make install
+```
+
+If the path to your Postgres installation is not in the PATH variable, add the path in the arguments:
+
+```console
+make PG_CONFIG=/path/to/postgres/bin/pg_config install
+```
+
+#### Setting up multiple versions of PostgreSQL
+
+Install the intended version of PostgreSQL (11 or 12).
+
+Use the pg_config to check if it points to the intended version of PostgreSQL, if it does we will have to PGBINROOT. Open /usr/bin/pg_config in write mode (might require root previllages) and edit the PGBINROOT value
+
+```console
+sudo vi /usr/bin/pg_config
+```
+
+By default PGBINROOT is set to /usr/lib/postsgresql , the directory which contains all the postgres versions. Change this to /usr/lib/postgresql/[intended version of postgres]
+
+Check the PostgreSQL conf file of your PostgreSQL version to figure out which port its running on.
+The conf file is generally located in /etc/postgresql/[intended version of postgres]/main
+
+```console
+vi /etc/postgresql/11/main/postgresql.conf
+```
+
+Check the PORT the particular version of PostgreSQL runs on by default.
+
+Restart PostgreSQL
+
+```console
+sudo service postgresql restart
+```
+Change user to postgres connect to the PostgreSQL server
+
+```console
+sudo su - postgres
+psql --port PORT
+```
+
+### Post Installation AGE Setup
+
+
+After the installation, open a connection to a running instance of your database and run the CREATE EXTENSION command to have AGE be installed on the server.
+
+```postgresql
+CREATE EXTENSION age;
+```
+
+## Installing via docker image
+
+### Get the docker image
+
+```shell
+docker pull apache/age
+```
+
+### On the terminal
+
+```shell
+docker run \
+ --name myPostgresDb \
+ -p 5455:5432 \
+ -e POSTGRES_USER=postgresUser \
+ -e POSTGRES_PASSWORD=postgresPW \
+ -e POSTGRES_DB=postgresDB \
+ -d \
+ apache/age
+```
+
+
+
+| Docker variables | Description |
+| ---------------- | -------------------------------------------------- |
+| `--name ` | Assign a name to the container |
+| `-p` | Publish a container's port(s) to the host |
+| `-e` | Set environment variables |
+| `-d` | Run container in background and print container ID |
+
+
+
+## Post Installation
+
+### Per Session Instructions
+
+For every connection of AGE you start you will need to load the AGE extension.
+
+```postgresql
+LOAD 'age';
+```
+
+We recommend adding ag_catalog to your search_path to simplify your queries. The rest of this document will assume you have done so. If you do not, remember to add 'ag_catalog' to your cypher query function calls.
+
+```postgresql
+SET search_path = ag_catalog, "$user", public;
+```
+
+### Optional: allow non-superusers to use Apache AGE
+
+* Non-superusers can only apply LOAD to library files located in `$libdir/plugins/` (see <https://www.postgresql.org/docs/11/sql-load.html>). A symlink can be created to allow non-superusers to LOAD the Apache AGE library:
+
+```console
+sudo ln -s /usr/lib/postgresql/11/lib/age.so /usr/lib/postgresql/11/lib/plugins/age.so
+```
+
+* In order to use Apache AGE, users need `USAGE` privileges on the `ag_catalog` schema (example for user `db_user`):
+
+```postgresql
+GRANT USAGE ON SCHEMA ag_catalog TO db_user;
+```
[age-website] 03/03: Merge branch 'developer-manual' of https://github.com/apache/age-website into developer-manual
Posted by jo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
joshinnis pushed a commit to branch developer-manual
in repository https://gitbox.apache.org/repos/asf/age-website.git
commit 548358e2c99bdf7085d48136d6005c6aa7d9f7c1
Merge: 1058fdf e2dce1e
Author: Josh Innis <Jo...@gmail.com>
AuthorDate: Wed Oct 26 13:14:42 2022 +0900
Merge branch 'developer-manual' of https://github.com/apache/age-website into developer-manual
.github/workflows/build-documentation.yml | 46 -------------
docs/postgres/node.md | 105 +++++++++++++++---------------
2 files changed, 53 insertions(+), 98 deletions(-)
[age-website] 02/03: Removed the Docker Instructions from the Developer Manual
Posted by jo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
joshinnis pushed a commit to branch developer-manual
in repository https://gitbox.apache.org/repos/asf/age-website.git
commit 1058fdf64968826ca971b944040459365299f5a9
Author: Josh Innis <Jo...@gmail.com>
AuthorDate: Wed Oct 26 13:14:16 2022 +0900
Removed the Docker Instructions from the Developer Manual
---
docs/intro/setup.md | 39 +--------------------------------------
1 file changed, 1 insertion(+), 38 deletions(-)
diff --git a/docs/intro/setup.md b/docs/intro/setup.md
index eb67d80..97dd27c 100644
--- a/docs/intro/setup.md
+++ b/docs/intro/setup.md
@@ -2,9 +2,6 @@
## Getting AGE
-### Releases
-
-The releases and release notes can be found at <https://github.com/apache/age/releases>
### Source code
@@ -62,7 +59,7 @@ sudo apt install postgresql-12
### Installation
-Clone the <a href='https://github.com/apache/age'>github repository</a> or <a href='https://github.com/apache/age/releases'>download an official release</a>
+Clone the <a href='https://github.com/apache/age'>github repository</a>
Run the pg_config utility and check the version of PostgreSQL, currently only PostgreSQL versions 11 & 12 are supported. If you have any other version of postgres, you will need to install PostgreSQL version 11 & 12. Follow Setting up multiple versions of PostgreSQL
```console
@@ -123,40 +120,6 @@ After the installation, open a connection to a running instance of your database
CREATE EXTENSION age;
```
-## Installing via docker image
-
-### Get the docker image
-
-```shell
-docker pull apache/age
-```
-
-### On the terminal
-
-```shell
-docker run \
- --name myPostgresDb \
- -p 5455:5432 \
- -e POSTGRES_USER=postgresUser \
- -e POSTGRES_PASSWORD=postgresPW \
- -e POSTGRES_DB=postgresDB \
- -d \
- apache/age
-```
-
-
-
-| Docker variables | Description |
-| ---------------- | -------------------------------------------------- |
-| `--name ` | Assign a name to the container |
-| `-p` | Publish a container's port(s) to the host |
-| `-e` | Set environment variables |
-| `-d` | Run container in background and print container ID |
-
-
-
-## Post Installation
-
### Per Session Instructions
For every connection of AGE you start you will need to load the AGE extension.