Skip to content

Commit 16fbc38

Browse files
committed
changed MAGE to Mage throughout documentation
1 parent e29c97e commit 16fbc38

File tree

31 files changed

+225
-225
lines changed

31 files changed

+225
-225
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Change Log
22

33
All notable changes to this project will be documented in this file.
4-
MAGE adheres to [Semantic Versioning](http://semver.org/).
4+
Mage adheres to [Semantic Versioning](http://semver.org/).
55

66
---
77

README.md

Lines changed: 83 additions & 83 deletions
Large diffs are not rendered by default.

aws_amazon_linux_2023.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
MAGE 6.2.x on Amazon Linux 2023
1+
Mage 6.2.x on Amazon Linux 2023
22

33
1. Install docker
44
```

docker/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Running with Docker
22

3-
## MAGE server image
3+
## Mage server image
44

5-
The MAGE Server image contains the the core MAGE server Node app that consists
6-
of the ReST web service and the MAGE web app. By default, the image also
7-
includes plugins maintained in the [MAGE server repository](../plugins/). By
5+
The Mage Server image contains the the core Mage server Node app that consists
6+
of the ReST web service and the Mage web app. By default, the image also
7+
includes plugins maintained in the [Mage server repository](../plugins/). By
88
default, the server [Dockerfile](./server/Dockerfile) pulls the latest tagged
99
versions from the NPM registry. You can override the version using Docker's
1010
`--build-arg` CLI switch to set the package versions you want in the image.
@@ -23,23 +23,23 @@ Dockerfile builds exactly the same as the standard Dockerfile.
2323

2424
## Docker Compose
2525

26-
You can start a MAGE server by using [docker compose](https://docs.docker.com/compose/) to start services
27-
defined in MAGE's [Compose file](docker-compose.yml).
26+
You can start a Mage server by using [docker compose](https://docs.docker.com/compose/) to start services
27+
defined in Mage's [Compose file](docker-compose.yml).
2828

29-
The first time you run MAGE with Docker, execute the following steps from the directory where you cloned the
30-
MAGE Git repository.
29+
The first time you run Mage with Docker, execute the following steps from the directory where you cloned the
30+
Mage Git repository.
3131
```bash
3232
$ cd ./docker
3333
$ docker compose up -d # build the service images, then create and start the service containers for the first time
3434
```
35-
If you want to use a MAGE server image tagged with a different version than
35+
If you want to use a Mage server image tagged with a different version than
3636
the `mage-server` Compose service currently defines, prepend the `MAGE_VERSION`
3737
environment variable to the command.
3838
```bash
3939
$ MAGE_VERSION=6.3.0-beta.1 docker compose up -d
4040
```
4141
With all the default settings, you should then be able to browse to
42-
http://localhost:4242 to interact with the MAGE web app.
42+
http://localhost:4242 to interact with the Mage web app.
4343

4444
## Interacting with the containers
4545

@@ -49,7 +49,7 @@ you are operating from the [`docker`](docker) directory.
4949
After the initial `up` command, you can use `docker compose stop` and
5050
`docker compose start` to stop and start the service containers.
5151

52-
You can use [`docker compose ps`](https://docs.docker.com/engine/reference/commandline/compose_ps/) to see the state of the MAGE service containers.
52+
You can use [`docker compose ps`](https://docs.docker.com/engine/reference/commandline/compose_ps/) to see the state of the Mage service containers.
5353
```bash
5454
$ docker compose ps
5555
NAME COMMAND SERVICE STATUS PORTS
@@ -59,10 +59,10 @@ docker-mage-server-1 "./mage.service --pl…" mage-server running
5959
You can use [`docker-compose logs <service>`](https://docs.docker.com/engine/reference/commandline/compose_logs/) to display console logging for a service.
6060
```
6161
$ docker compose logs mage-server
62-
mage-server_1 | 2018-04-26T23:30:30.684Z - info: Starting MAGE Server ...
62+
mage-server_1 | 2018-04-26T23:30:30.684Z - info: Starting Mage Server ...
6363
mage-server_1 | 2018-04-26T23:30:31.403Z - info: setting up provision uid
6464
mage-server_1 | 2018-04-26T23:30:31.861Z - info: Using '/var/lib/mage/attachments' as base directory for feature attachments.
65-
mage-server_1 | 2018-04-26T23:30:31.861Z - info: Using '/var/lib/mage/icons' as base directory for MAGE icons.
65+
mage-server_1 | 2018-04-26T23:30:31.861Z - info: Using '/var/lib/mage/icons' as base directory for Mage icons.
6666
# etc., etc.
6767
```
6868
While the service containers are up, you can interact with them using
@@ -75,7 +75,7 @@ UID PID PPID C STIME TTY TIME CMD
7575
mongodb 1 0 0 07:16 ? 00:03:47 mongod --dbpath /data/mage --logpath /var/log
7676
root 67 0 0 22:37 pts/0 00:00:00 bash
7777
root 73 67 0 22:37 pts/0 00:00:00 ps -ef
78-
root@df8b00beafa2:/# mongo # interact directly with the running MAGE database # do some ill-advised things directly to the database
78+
root@df8b00beafa2:/# mongo # interact directly with the running Mage database # do some ill-advised things directly to the database
7979
MongoDB shell version v3.6.3
8080
connecting to: mongodb://127.0.0.1:27017
8181
MongoDB server version: 3.6.3
@@ -112,22 +112,22 @@ users
112112

113113
### App Services
114114

115-
The MAGE Server Docker app consists of three service containers: the MongoDB
116-
database, the MAGE Node.js app, and the optional nginx TLS reverse proxy.
115+
The Mage Server Docker app consists of three service containers: the MongoDB
116+
database, the Mage Node.js app, and the optional nginx TLS reverse proxy.
117117

118118
### MongoDB
119119

120120
The MongoDB image is the official MongoDB image available from [Docker Hub](https://hub.docker.com/_/mongo/). The Compose
121121
file builds that image unmodified, but uses a custom command to launch MongoDB with specific settings. The Compose file
122122
runs MongoDB as the service `mage-db`.
123123

124-
### MAGE server
124+
### Mage server
125125

126126
The Compose file references a custom, local [Dockerfile](server/Dockerfile) based on the official [Node.js](https://hub.docker.com/_/node/)
127-
image to build the MAGE server image. At build time, the MAGE server Dockerfile
128-
copies whatever MAGE server package tarballs you supply into the MAGE server
127+
image to build the Mage server image. At build time, the Mage server Dockerfile
128+
copies whatever Mage server package tarballs you supply into the Mage server
129129
image, which might not match the default version the Compose currently defines.
130-
If you want the MAGE server image that Compose builds to have a different tag,
130+
If you want the Mage server image that Compose builds to have a different tag,
131131
override the `MAGE_VERSION` default value in the Compose file.
132132
```bash
133133
MAGE_VERSION=6.2.0 docker compose build

docs/admin/auth.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# MAGE Authentication and Identity Providers
1+
# Mage Authentication and Identity Providers
22

33
To configure authentication settings and identity providers
4-
1. Click the gear icon in the upper right of the MAGE web app to load the _Admin_ page.
4+
1. Click the gear icon in the upper right of the Mage web app to load the _Admin_ page.
55
1. Click, the _Settings_ tab in the tab strip on the left of the page.
66
1. Click the _Authentication_ tab near the top of the main content pane. This tab should be selected by default.
77
1. Click any of the accordion headings to expand the section for the authentication you want to configure, or
@@ -11,13 +11,13 @@ To configure authentication settings and identity providers
1111

1212
## OAuth 2.0
1313

14-
Here is an example of using Google's OAuth 2.0 [endpoints](https://developers.google.com/identity/gsi/web/guides/overview) to authenticate MAGE
14+
Here is an example of using Google's OAuth 2.0 [endpoints](https://developers.google.com/identity/gsi/web/guides/overview) to authenticate Mage
1515
users. This setup is very similar to Google OpenID Connect authentication.
1616

1717
Obtain your _Client Identifier_ and _Client Secret_ from Google's [API Console](https://console.cloud.google.com/apis/credentials/oauthclient).
1818
Additionally on that page, ensure you register the correct callback URL, e.g., `https://mage.example.com/auth/oauth/callback`
1919

20-
On the MAGE Admin page, click the _Settings_ tab.
20+
On the Mage Admin page, click the _Settings_ tab.
2121

2222
_Authorization URL_ - `https://accounts.google.com/o/oauth2/v2/auth`
2323
_Token URL_ - `https://oauth2.googleapis.com/token`
@@ -30,7 +30,7 @@ _Display Name Property_ - `name`
3030

3131
## LDAP
3232

33-
You can setup MAGE to authenticate users with an LDAP server. For development
33+
You can setup Mage to authenticate users with an LDAP server. For development
3434
testing, the [`auth-idp`](../docker/auth-idp/docker-compose.yml) Compose file
3535
uses the [osixia/openldap](https://github.com/osixia/docker-openldap) and
3636
[osixia/phpLDAPAdmin](https://github.com/osixia/docker-phpLDAPAdmin) images
@@ -79,9 +79,9 @@ Using the phpLDAPAdmin UI to setup a simple group structure.
7979
You now have a simple group structure and user account in your LDAP database.
8080

8181
Now that you have an LDAP database with a user account, you can configure LDAP
82-
authentication in MAGE. This assumes you're running a MAGE server on
82+
authentication in Mage. This assumes you're running a Mage server on
8383
http://localhost:4242.
84-
1. Open the MAGE web app in your browser.
84+
1. Open the Mage web app in your browser.
8585
1. Click the gear icon in the top right to load the _Admin_ page.
8686
1. Click the _Security_ tab in the vertical tab strip on the left.
8787
1. Click the _New Authentication_ button.
@@ -108,15 +108,15 @@ http://localhost:4242.
108108
1. Adjust the color settings to your preference.
109109
1. Click the _Next_ button.
110110
1. Review the settings and click the _Save_ button.
111-
1. Open a new private browser tab or window and load your MAGE server web app.
111+
1. Open a new private browser tab or window and load your Mage server web app.
112112
1. The sign-in page should display a button labeled _SIGN IN WITH LOCAL LDAP_
113113
under two text fields.
114114
1. In the _Local LDAP Username_ text field, enter `batman`.
115115
1. In the _Local LDAP Password_ text field, enter `i heart alfred`.
116116
1. Click the _SIGN IN WITH LOCAL LDAP_ button.
117117
1. The page will most likely display a dialog that states the account needs
118118
admin approval.
119-
1. In the browser tab with your MAGE admin page, click the _Users_ tab in the
119+
1. In the browser tab with your Mage admin page, click the _Users_ tab in the
120120
tab strip on the left.
121121
1. Click the _Inactive_ search facet near the top left of the main pane. The
122122
user list should contain the _Batman_ user with a green _Activate_ button.
@@ -130,7 +130,7 @@ http://localhost:4242.
130130
1. You are now authenticated with your LDAP account.
131131

132132
## SAML
133-
You can setup MAGE to authenticate users with an SAML server. For development
133+
You can setup Mage to authenticate users with an SAML server. For development
134134
testing, the [`auth-idp`](../docker/auth-idp/docker-compose.yml) Compose file
135135
uses the [kristophjunge/test-saml-idp](https://github.com/kristophjunge/docker-test-saml-idp)
136136
Start the `mage-idp-saml` SAML
@@ -144,7 +144,7 @@ The docker compose file is set to seed a few users with the .saml/authsources.ph
144144
file is mounted under volumes in the docker compose. Once it is spun up, you are ready to
145145
configure your saml authentication provider.
146146

147-
1. Open the MAGE web app in your browser.
147+
1. Open the Mage web app in your browser.
148148
1. Click the gear icon in the top right to load the _Admin_ page.
149149
1. Click the _Security_ tab in the vertical tab strip on the left.
150150
1. Click the _New Authentication_ button.
@@ -168,7 +168,7 @@ configure your saml authentication provider.
168168
1. Adjust the color settings to your preference.
169169
1. Click the _Next_ button.
170170
1. Review the settings and click the _Save_ button.
171-
1. Open a new private browser tab or window and load your MAGE server web app.
171+
1. Open a new private browser tab or window and load your Mage server web app.
172172
1. The sign-in page should display a button labeled _Continue with SAML_
173173
1. Clicking this button will take you to a simple login page where the saml server is running.
174174
1. for Username enter `saml.user1`

0 commit comments

Comments
 (0)