-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
177 lines (110 loc) · 6.58 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
=== {eac}Doojigger Simple AWS Extension for WordPress ===
Plugin URI: https://eacdoojigger.earthasylum.com/eacsimpleaws/
Author: [EarthAsylum Consulting](https://www.earthasylum.com)
Stable tag: 1.0.2
Last Updated: 10-Apr-2024
Requires at least: 5.8
Tested up to: 6.6
Requires PHP: 7.4
Requires EAC: 2.0
Contributors: kevinburkholder
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl.html
Tags: aws, amazon web services, AWS PHP SDK, {eac}Doojigger
WordPress URI: https://wordpress.org/plugins/eacsimpleaws
GitHub URI: https://github.com/EarthAsylum/eacSimplaAWS
{eac}SimpleAWS includes and enables use of the Amazon Web Services (AWS) PHP Software Development Kit (SDK).
== Description ==
Once enabled, AWS services are easily accessable from other plugins, extensions and custom functions.
From the settings page, you can enter your AWS Region and your IAM account credentials to access AWS programmatically.
Please review:
+ [Policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)
+ [Managing access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
= Available Methods: =
`getAwsRegion()` returns your selected region
`getAwsAccessKey()` returns your access key
`getAwsAccessSecret()` returns your access secret
`getAwsCredentials()` returns a 'credentials' array with your key and secret
`getAwsClientParams()` returns an AWS client instantiation array
`getAwsEndpoints()` returns a (large) array of all AWS endpoint parameters
`getAwsRegions()` returns an array of all regions (name=>description)
`setAwsVersion()` override default ('latest') version
`setAwsRegion()` override set region
`setAwsEndPoint()` override default endpoint
= Available Filters: =
`SimpleAWS_version` returns the AWS version string
`SimpleAWS_region` returns your selected region
`SimpleAWS_access_key` returns your access key
`SimpleAWS_access_secret` returns your access secret
`SimpleAWS_credentials` returns a 'credentials' array with your key and secret
`SimpleAWS_client_params` returns an AWS client instantiation array
`SimpleAWS_endpoints` returns a (large) array of all AWS endpoint parameters
`SimpleAWS_regions` returns an array of all regions (name=>description)
= Examples: =
$cloudFront = new Aws\CloudFront\CloudFrontClient([
'version' => 'latest',
'region' => apply_filters('SimpleAWS_region',''),
'credentials' => [
'key' => apply_filters('SimpleAWS_access_key',''),
'secret' => apply_filters('SimpleAWS_access_secret','')
]
]);
if ($aws = $this->getExtension('Simple_AWS')) {
$cloudFront = new Aws\CloudFront\CloudFrontClient([
'version' => 'latest',
'region' => $aws->getAwsRegion(),
'credentials' => $aws->getAwsCredentials(),
]);
}
if ($aws = eacDoojigger()->getExtension('Simple_AWS')) {
$cloudFront = new Aws\CloudFront\CloudFrontClient([
'version' => $aws->getAwsVersion(),
'region' => $aws->getAwsRegion(),
'credentials' => $aws->getAwsCredentials(),
]);
}
if ($aws = $this->getExtension('Simple_AWS')) {
$cloudFront = new Aws\CloudFront\CloudFrontClient(
$aws->getAwsClientParams()
);
}
if ($aws = eacDoojigger()->getExtension('Simple_AWS')) {
$cloudFront = new Aws\CloudFront\CloudFrontClient(
$aws->getAwsClientParams()
);
}
== Installation ==
**{eac}Doojigger Simple AWS Extension** is an extension plugin to and requires installation and registration of [{eac}Doojigger](https://eacDoojigger.earthasylum.com/).
= Automatic Plugin Installation =
This plugin is available from the [WordPress Plugin Repository](https://wordpress.org/plugins/search/earthasylum/) and can be installed from the WordPress Dashboard » *Plugins* » *Add New* page. Search for 'EarthAsylum', click the plugin's [Install] button and, once installed, click [Activate].
See [Managing Plugins -> Automatic Plugin Installation](https://wordpress.org/support/article/managing-plugins/#automatic-plugin-installation-1)
= Upload via WordPress Dashboard =
Installation of this plugin can be managed from the WordPress Dashboard » *Plugins* » *Add New* page. Click the [Upload Plugin] button, then select the eacsimpleaws.zip file from your computer.
See [Managing Plugins -> Upload via WordPress Admin](https://wordpress.org/support/article/managing-plugins/#upload-via-wordpress-admin)
= Manual Plugin Installation =
You can install the plugin manually by extracting the eacsimpleaws.zip file and uploading the 'eacsimpleaws' folder to the 'wp-content/plugins' folder on your WordPress server.
See [Managing Plugins -> Manual Plugin Installation](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation-1)
= Settings =
Once installed and activated options for this extension will show in the 'General' tab of {eac}Doojigger settings.
== Screenshots ==
1. Simple AWS
2. Simple AWS Help
== Other Notes ==
= Additional Information =
+ {eac}SimpleAWS is an extension plugin to and requires installation and registration of [{eac}Doojigger](https://eacDoojigger.earthasylum.com/).
== Copyright ==
= Copyright © 2023-2024, EarthAsylum Consulting, distributed under the terms of the GNU GPL. =
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should receive a copy of the GNU General Public License along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
== Changelog ==
= Version 1.0.2 – April 10, 2024 =
+ Added notice if activated without {eac}Doojigger.
+ Updated AWS PHP SDK to version 3.304.1
= Version 1.0.1 – September 9, 2023 =
+ Updated include file to prevent direct access.
+ Updated AWS PHP SDK to version 3.281.3
= Version 1.0.0 – June 3, 2023 =
+ Initial release.