iaurora 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +200 -200
- package/README.md +157 -235
- package/bin/aurora.exe +0 -0
- package/bin/aurora.js +1 -1
- package/config.yaml +1 -1
- package/package.json +4 -4
- package/scripts/npm-postinstall.js +1 -1
package/LICENSE
CHANGED
|
@@ -1,201 +1,201 @@
|
|
|
1
1
|
Apache License
|
|
2
|
-
Version 2.0, January 2004
|
|
3
|
-
http://www.apache.org/licenses/
|
|
4
|
-
|
|
5
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
-
|
|
7
|
-
1. Definitions.
|
|
8
|
-
|
|
9
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
-
|
|
12
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
-
the copyright owner that is granting the License.
|
|
14
|
-
|
|
15
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
-
other entities that control, are controlled by, or are under common
|
|
17
|
-
control with that entity. For the purposes of this definition,
|
|
18
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
-
direction or management of such entity, whether by contract or
|
|
20
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
-
|
|
23
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
-
exercising permissions granted by this License.
|
|
25
|
-
|
|
26
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
-
including but not limited to software source code, documentation
|
|
28
|
-
source, and configuration files.
|
|
29
|
-
|
|
30
|
-
"Object" form shall mean any form resulting from mechanical
|
|
31
|
-
transformation or translation of a Source form, including but
|
|
32
|
-
not limited to compiled object code, generated documentation,
|
|
33
|
-
and conversions to other media types.
|
|
34
|
-
|
|
35
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
-
Object form, made available under the License, as indicated by a
|
|
37
|
-
copyright notice that is included in or attached to the work
|
|
38
|
-
(an example is provided in the Appendix below).
|
|
39
|
-
|
|
40
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
-
form, that is based on (or derived from) the Work and for which the
|
|
42
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
-
of this License, Derivative Works shall not include works that remain
|
|
45
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
-
the Work and Derivative Works thereof.
|
|
47
|
-
|
|
48
|
-
"Contribution" shall mean any work of authorship, including
|
|
49
|
-
the original version of the Work and any modifications or additions
|
|
50
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
-
means any form of electronic, verbal, or written communication sent
|
|
55
|
-
to the Licensor or its representatives, including but not limited to
|
|
56
|
-
communication on electronic mailing lists, source code control systems,
|
|
57
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
-
excluding communication that is conspicuously marked or otherwise
|
|
60
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
-
|
|
62
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
-
subsequently incorporated within the Work.
|
|
65
|
-
|
|
66
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
-
Work and such Derivative Works in Source or Object form.
|
|
72
|
-
|
|
73
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
-
(except as stated in this section) patent license to make, have made,
|
|
77
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
-
where such license applies only to those patent claims licensable
|
|
79
|
-
by such Contributor that are necessarily infringed by their
|
|
80
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
-
institute patent litigation against any entity (including a
|
|
83
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
-
or contributory patent infringement, then any patent licenses
|
|
86
|
-
granted to You under this License for that Work shall terminate
|
|
87
|
-
as of the date such litigation is filed.
|
|
88
|
-
|
|
89
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
-
modifications, and in Source or Object form, provided that You
|
|
92
|
-
meet the following conditions:
|
|
93
|
-
|
|
94
|
-
(a) You must give any other recipients of the Work or
|
|
95
|
-
Derivative Works a copy of this License; and
|
|
96
|
-
|
|
97
|
-
(b) You must cause any modified files to carry prominent notices
|
|
98
|
-
stating that You changed the files; and
|
|
99
|
-
|
|
100
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
-
that You distribute, all copyright, patent, trademark, and
|
|
102
|
-
attribution notices from the Source form of the Work,
|
|
103
|
-
excluding those notices that do not pertain to any part of
|
|
104
|
-
the Derivative Works; and
|
|
105
|
-
|
|
106
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
-
distribution, then any Derivative Works that You distribute must
|
|
108
|
-
include a readable copy of the attribution notices contained
|
|
109
|
-
within such NOTICE file, excluding those notices that do not
|
|
110
|
-
pertain to any part of the Derivative Works, in at least one
|
|
111
|
-
of the following places: within a NOTICE text file distributed
|
|
112
|
-
as part of the Derivative Works; within the Source form or
|
|
113
|
-
documentation, if provided along with the Derivative Works; or,
|
|
114
|
-
within a display generated by the Derivative Works, if and
|
|
115
|
-
wherever such third-party notices normally appear. The contents
|
|
116
|
-
of the NOTICE file are for informational purposes only and
|
|
117
|
-
do not modify the License. You may add Your own attribution
|
|
118
|
-
notices within Derivative Works that You distribute, alongside
|
|
119
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
-
that such additional attribution notices cannot be construed
|
|
121
|
-
as modifying the License.
|
|
122
|
-
|
|
123
|
-
You may add Your own copyright statement to Your modifications and
|
|
124
|
-
may provide additional or different license terms and conditions
|
|
125
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
-
the conditions stated in this License.
|
|
129
|
-
|
|
130
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
-
this License, without any additional terms or conditions.
|
|
134
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
-
the terms of any separate license agreement you may have executed
|
|
136
|
-
with Licensor regarding such Contributions.
|
|
137
|
-
|
|
138
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
-
except as required for reasonable and customary use in describing the
|
|
141
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
-
|
|
143
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
-
implied, including, without limitation, any warranties or conditions
|
|
148
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
-
appropriateness of using or redistributing the Work and assume any
|
|
151
|
-
risks associated with Your exercise of permissions under this License.
|
|
152
|
-
|
|
153
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
-
unless required by applicable law (such as deliberate and grossly
|
|
156
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
-
liable to You for damages, including any direct, indirect, special,
|
|
158
|
-
incidental, or consequential damages of any character arising as a
|
|
159
|
-
result of this License or out of the use or inability to use the
|
|
160
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
-
other commercial damages or losses), even if such Contributor
|
|
163
|
-
has been advised of the possibility of such damages.
|
|
164
|
-
|
|
165
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
-
or other liability obligations and/or rights consistent with this
|
|
169
|
-
License. However, in accepting such obligations, You may act only
|
|
170
|
-
on Your own behalf and on
|
|
171
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
-
defend, and hold each Contributor harmless for any liability
|
|
173
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
-
of your accepting any such warranty or additional liability.
|
|
175
|
-
|
|
176
|
-
END OF TERMS AND CONDITIONS
|
|
177
|
-
|
|
178
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
-
|
|
180
|
-
To apply the Apache License to your work, attach the following
|
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
-
replaced with your own identifying information. (Don't include
|
|
183
|
-
the brackets!)
|
|
184
|
-
comment syntax for the file format. We also recommend that a
|
|
185
|
-
file or class name and description of purpose be included on the
|
|
186
|
-
same "printed page" as the copyright notice for easier
|
|
187
|
-
identification within third-party archives.
|
|
188
|
-
|
|
189
|
-
Copyright 2025 Gurveer
|
|
190
|
-
|
|
191
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
-
you may not use this file except in compliance with the License.
|
|
193
|
-
You may obtain a copy of the License at
|
|
194
|
-
|
|
195
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
-
|
|
197
|
-
Unless required by applicable law or agreed to in writing, software
|
|
198
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
-
See the License for the specific language governing permissions and
|
|
201
|
-
limitations under the License.
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Gurveer
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,313 +1,235 @@
|
|
|
1
|
-
<
|
|
1
|
+
<p align="center">
|
|
2
|
+
<svg viewBox="0 0 32 32" width="96" height="96" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
3
|
+
<style>
|
|
4
|
+
.w1 { stroke-dasharray: 40; stroke-dashoffset: 40; animation: draw 1.8s ease forwards; }
|
|
5
|
+
.w2 { stroke-dasharray: 50; stroke-dashoffset: 50; animation: draw 2.2s ease 0.3s forwards; }
|
|
6
|
+
.w3 { stroke-dasharray: 35; stroke-dashoffset: 35; animation: draw 1.6s ease 0.6s forwards; }
|
|
7
|
+
.dot { animation: pulse 2.5s ease-in-out infinite; }
|
|
8
|
+
@keyframes draw { to { stroke-dashoffset: 0; } }
|
|
9
|
+
@keyframes pulse { 0%,100% { opacity: 1; transform-origin: 16px 16px; } 50% { opacity: 0.5; r: 2.8; } }
|
|
10
|
+
</style>
|
|
11
|
+
<path class="w1" d="M4 20 C8 12, 14 10, 16 16 C18 22, 24 20, 28 12" stroke="#6AD87A" stroke-width="1.8" stroke-linecap="round" fill="none" opacity="0.5"/>
|
|
12
|
+
<path class="w2" d="M2 24 C8 14, 14 8, 16 18 C18 28, 24 22, 30 14" stroke="#6AD87A" stroke-width="1.8" stroke-linecap="round" fill="none" opacity="0.35"/>
|
|
13
|
+
<path class="w3" d="M6 16 C10 10, 14 12, 16 14 C18 16, 22 14, 26 10" stroke="#6AD87A" stroke-width="1.8" stroke-linecap="round" fill="none" opacity="0.65"/>
|
|
14
|
+
<circle class="dot" cx="16" cy="16" r="2.2" fill="#6AD87A"/>
|
|
15
|
+
</svg>
|
|
16
|
+
</p>
|
|
2
17
|
|
|
3
|
-
<
|
|
18
|
+
<h1 align="center">Aurora Gateway</h1>
|
|
4
19
|
|
|
5
|
-
|
|
20
|
+
<p align="center">
|
|
21
|
+
<a href="LICENSE"><img src="https://img.shields.io/github/license/aurorallm/aurora" alt="License" height="20"></a>
|
|
22
|
+
<a href="https://www.npmjs.com/package/iaurora"><img src="https://img.shields.io/npm/v/iaurora" alt="npm" height="20"></a>
|
|
23
|
+
<a href="https://goreportcard.com/report/github.com/aurorallm/aurora"><img src="https://goreportcard.com/badge/github.com/aurorallm/aurora" alt="Go Report Card" height="20"></a>
|
|
24
|
+
<a href="https://codecov.io/gh/aurorallm/aurora"><img src="https://codecov.io/gh/aurorallm/aurora/branch/main/graph/badge.svg" alt="codecov" height="20"></a>
|
|
25
|
+
<a href="https://github.com/aurorallm/aurora"><img src="https://img.shields.io/github/stars/aurorallm/aurora" alt="GitHub Stars" height="20"></a>
|
|
26
|
+
<a href="https://discord.gg/YJPrfR9uh"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/YJPrfR9uh?style=flat" alt="Discord" height="20"></a>
|
|
27
|
+
<img src="https://img.shields.io/docker/pulls/aurorallm/aurora" alt="Docker Pulls" height="20">
|
|
28
|
+
<a href="https://app.getpostman.com/run-collection/31642484-2ba0e658-4dcd-49f4-845a-0c7ed745b916?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D31642484-2ba0e658-4dcd-49f4-845a-0c7ed745b916%26entityType%3Dcollection%26workspaceId%3D63e853c8-9aec-477f-909c-7f02f543150e"><img src="https://run.pstmn.io/button.svg" alt="Run In Postman" height="20"></a>
|
|
29
|
+
<a href="https://artifacthub.io/packages/search?repo=aurora"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/aurora" alt="Artifact Hub" height="20"></a>
|
|
30
|
+
</p>
|
|
6
31
|
|
|
7
|
-
|
|
32
|
+
## One gateway. Every provider. Open source.
|
|
8
33
|
|
|
9
34
|
Route AI traffic through a single OpenAI- and Anthropic-compatible API.
|
|
10
35
|
Self-hosted. No vendor lock-in. Full source visibility.
|
|
11
36
|
|
|
12
|
-
<table>
|
|
13
|
-
<tr>
|
|
14
|
-
<td><a href="https://github.com/gurveeer/Aurora/actions/workflows/test.yml"><img src="https://github.com/gurveeer/Aurora/actions/workflows/test.yml/badge.svg" alt="CI"></a></td>
|
|
15
|
-
<td><a href="https://github.com/gurveeer/Aurora/blob/main/go.mod"><img src="https://img.shields.io/github/go-mod/go-version/gurveeer/Aurora?style=flat-square&label=Go" alt="Go Version"></a></td>
|
|
16
|
-
<td><a href="https://github.com/gurveeer/Aurora/releases"><img src="https://img.shields.io/github/v/release/gurveeer/Aurora?style=flat-square" alt="Release"></a></td>
|
|
17
|
-
<td><a href="https://github.com/gurveeer/Aurora/stargazers"><img src="https://img.shields.io/github/stars/gurveeer/Aurora?style=flat-square" alt="Stars"></a></td>
|
|
18
|
-
</tr>
|
|
19
|
-
<tr>
|
|
20
|
-
<td><a href="LICENSE"><img src="https://img.shields.io/github/license/gurveeer/Aurora?style=flat-square" alt="License"></a></td>
|
|
21
|
-
<td><a href="https://hub.docker.com/r/gurveeer/Aurora"><img src="https://img.shields.io/docker/pulls/gurveeer/Aurora?style=flat-square" alt="Docker Pulls"></a></td>
|
|
22
|
-
<td><a href="https://github.com/gurveeer/Aurora/commits/main"><img src="https://img.shields.io/github/last-commit/gurveeer/Aurora?style=flat-square" alt="Last Commit"></a></td>
|
|
23
|
-
<td><a href="https://github.com/gurveeer/Aurora/issues"><img src="https://img.shields.io/github/issues/gurveeer/Aurora?style=flat-square" alt="Open Issues"></a></td>
|
|
24
|
-
</tr>
|
|
25
|
-
<tr>
|
|
26
|
-
<td><a href="https://github.com/gurveeer/Aurora/pulls"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen?style=flat-square" alt="PRs Welcome"></a></td>
|
|
27
|
-
<td><a href="https://discord.gg/YJPrfR9uh"><img src="https://img.shields.io/badge/Discord-Join-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord"></a></td>
|
|
28
|
-
<td></td>
|
|
29
|
-
<td></td>
|
|
30
|
-
</tr>
|
|
31
|
-
</table>
|
|
32
|
-
|
|
33
37
|
<a href="docs/assets/dashboard-overview.png">
|
|
34
38
|
<img src="docs/assets/dashboard-overview.png" alt="Aurora dashboard" width="100%">
|
|
35
39
|
</a>
|
|
36
40
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## Start your selfhosted gateway
|
|
41
|
+
## Quick Start
|
|
42
42
|
|
|
43
|
-
**
|
|
43
|
+
**Go from zero to running in under a minute.**
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
docker run --rm -p 8080:8080 \
|
|
47
|
-
-e OPENAI_API_KEY="sk-..." \
|
|
48
|
-
gurveeer/Aurora
|
|
49
|
-
```
|
|
45
|
+
<img src="./install.gif" alt="Install demo" style="max-width:100%;border-radius:12px;margin:12px 0;">
|
|
50
46
|
|
|
51
|
-
**
|
|
47
|
+
**1. Install Aurora Gateway**
|
|
52
48
|
|
|
53
49
|
```bash
|
|
54
50
|
npm install -g iaurora
|
|
55
|
-
#
|
|
56
|
-
|
|
51
|
+
# or
|
|
52
|
+
docker run --rm -p 8080:8080 \
|
|
53
|
+
-e AURORA_MASTER_KEY="your-key" \
|
|
54
|
+
-e GROQ_API_KEY="gsk_..." \
|
|
55
|
+
aurorallm/aurora
|
|
57
56
|
```
|
|
58
57
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**From source**
|
|
58
|
+
**2. Init and start**
|
|
62
59
|
|
|
63
60
|
```bash
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
61
|
+
mkdir my-gateway && cd my-gateway
|
|
62
|
+
aurora init # scaffolds config.yaml, .env, data/
|
|
63
|
+
aurora # starts gateway on port 8080
|
|
67
64
|
```
|
|
68
65
|
|
|
69
|
-
|
|
66
|
+
**3. Make your first request**
|
|
70
67
|
|
|
71
68
|
```bash
|
|
72
69
|
curl http://localhost:8080/v1/chat/completions \
|
|
73
70
|
-H "Content-Type: application/json" \
|
|
74
|
-
-
|
|
71
|
+
-H "Authorization: Bearer $(grep AURORA_MASTER_KEY .env | cut -d= -f2)" \
|
|
72
|
+
-d '{"model":"groq/llama-3.3-70b-versatile","messages":[{"role":"user","content":"Hello!"}]}'
|
|
75
73
|
```
|
|
76
74
|
|
|
77
|
-
|
|
78
|
-
|---|---|
|
|
79
|
-
| Dashboard | `http://localhost:8080/admin/dashboard` |
|
|
80
|
-
| Health check | `http://localhost:8080/health` |
|
|
81
|
-
| Swagger | `http://localhost:8080/swagger/index.html` |
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## What it does
|
|
75
|
+
The dashboard is at `http://localhost:8080/admin/dashboard`.
|
|
86
76
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
<p align="center">
|
|
90
|
-
<a href="docs/assets/analytics-overview.png">
|
|
91
|
-
<img src="docs/assets/analytics-overview.png" alt="Usage analytics" width="48%">
|
|
92
|
-
</a>
|
|
93
|
-
<a href="docs/assets/audit-logs.png">
|
|
94
|
-
<img src="docs/assets/audit-logs.png" alt="Audit logs" width="48%">
|
|
95
|
-
</a>
|
|
96
|
-
</p>
|
|
97
|
-
|
|
98
|
-
**Unified API** -- `/v1/chat/completions`, `/v1/responses`, `/v1/embeddings`, `/v1/models`, `/v1/files`, `/v1/batches`
|
|
99
|
-
|
|
100
|
-
**12 providers** -- OpenAI, Anthropic, Gemini, DeepSeek, Groq, OpenRouter, Z.ai, xAI, Azure OpenAI, Oracle, Ollama, vLLM (and any OpenAI-compatible backend)
|
|
101
|
-
|
|
102
|
-
**Routing** -- Model aliases, provider pools, fallback chains, workflow pipelines, passthrough routes
|
|
103
|
-
|
|
104
|
-
**Dashboard** -- Live usage analytics, provider status, cache hit rates, cost tracking, audit logs
|
|
105
|
-
|
|
106
|
-
**Controls** -- Managed API keys, model overrides, guardrails, pricing recalculation, exact + semantic response caching
|
|
107
|
-
|
|
108
|
-
**Storage** -- SQLite (default), PostgreSQL, MongoDB
|
|
77
|
+
**Setup guides:** [npm](https://www.npmjs.com/package/iaurora) · [Docker](https://hub.docker.com/r/aurorallm/aurora) · [Source](https://github.com/aurorallm/aurora)
|
|
109
78
|
|
|
110
79
|
---
|
|
111
80
|
|
|
112
|
-
##
|
|
113
|
-
|
|
114
|
-
This repository is intended to be published as the **Aurora OSS source tree**. It should contain source code, tests, examples, generated OpenAPI/docs assets, and public documentation only.
|
|
115
|
-
|
|
116
|
-
**Current review status:** source publish is acceptable after the checks below pass locally. Do not publish any local runtime files, compiled binaries, package tarballs, databases, logs, or machine-specific configuration.
|
|
81
|
+
## Enterprise Deployments
|
|
117
82
|
|
|
118
|
-
|
|
83
|
+
Aurora supports enterprise-grade deployments for teams running production AI systems at scale.
|
|
84
|
+
In addition to private networking, custom security controls, and governance, **Aurora Enterprise** unlocks advanced capabilities including SSO, RBAC, tenant isolation, budget enforcement, compliance workflows, and production support.
|
|
119
85
|
|
|
120
|
-
|
|
86
|
+
The Enterprise edition is a separate distribution with a signed license — it cannot be enabled by editing files in this tree.
|
|
121
87
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
- Tests under `test/` and public fixtures with dummy credentials only.
|
|
126
|
-
- CI, release, Docker, Helm, and packaging scripts.
|
|
127
|
-
|
|
128
|
-
Excluded from the OSS boundary:
|
|
129
|
-
|
|
130
|
-
- Local environment files: `.env`, `.env.*`, `.aurora.local/`.
|
|
131
|
-
- Runtime data: `data/`, logs, caches, SQLite files, benchmark output, and temporary files.
|
|
132
|
-
- Build/package output: `bin/`, `dist/`, `release/`, `npm/`, `*.exe`, `*.tgz`, archives.
|
|
133
|
-
- User/editor/agent config that may contain private paths or endpoints: `.vscode/`, `.idea/`, `opencode.json`, `.claude/settings.local.json`.
|
|
134
|
-
- Any provider API key, database URL, Redis URL, vector DB token, private certificate/key, or managed API key.
|
|
88
|
+
<a href="./comparison.png">
|
|
89
|
+
<img src="./comparison.png" alt="OSS vs Enterprise comparison" width="100%" style="border-radius:12px;margin:16px 0;">
|
|
90
|
+
</a>
|
|
135
91
|
|
|
136
|
-
|
|
92
|
+
<div align="center">
|
|
93
|
+
<a href="https://discord.com/invite/YJPrfR9uh">
|
|
94
|
+
<img src="https://img.shields.io/badge/Contact%20Us-Enterprise-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Contact Us" width="200" style="margin-top:5px;"/>
|
|
95
|
+
</a>
|
|
96
|
+
</div>
|
|
137
97
|
|
|
138
|
-
|
|
98
|
+
---
|
|
139
99
|
|
|
140
|
-
|
|
141
|
-
- Live Redis/PostgreSQL/Qdrant connection strings.
|
|
142
|
-
- Private certificates and key material.
|
|
143
|
-
- Local absolute paths and machine-specific `.aurora.local` files.
|
|
144
|
-
- Generated binaries and package archives.
|
|
100
|
+
## Key Features
|
|
145
101
|
|
|
146
|
-
|
|
102
|
+
### Core Infrastructure
|
|
147
103
|
|
|
148
|
-
|
|
104
|
+
- **Unified Interface** — Single OpenAI- and Anthropic-compatible API for all providers
|
|
105
|
+
- **Multi-Provider Support** — 15+ providers auto-discovered from env vars (OpenAI, Anthropic, Gemini, Groq, DeepSeek, and more)
|
|
106
|
+
- **Automatic Fallbacks** — Seamless failover with fallback routing and combo models
|
|
107
|
+
- **Model Discovery** — Providers and models auto-detected from environment variables
|
|
149
108
|
|
|
150
|
-
|
|
151
|
-
- Keep `LOGGING_LOG_BODIES=false` and `LOGGING_LOG_HEADERS=false` unless you explicitly need request debugging and understand the privacy impact.
|
|
152
|
-
- Use `.env.template` as documentation only. Put real values in untracked `.env` files, deployment secrets, or your hosting provider's secret manager.
|
|
153
|
-
- Rotate any credential that was ever present in a local `.env`, `.aurora.local`, package artifact, shell history, or shared archive before public release.
|
|
154
|
-
- Audit logs hash API keys for identification and redact sensitive headers in reader paths, but request/response body logging can still capture sensitive prompts if enabled.
|
|
109
|
+
### Advanced Features
|
|
155
110
|
|
|
156
|
-
|
|
111
|
+
- **Admin Dashboard** — Web UI for managing providers, API keys, models, and combos
|
|
112
|
+
- **Semantic Caching** — Intelligent response caching based on semantic similarity to reduce costs and latency
|
|
113
|
+
- **Anthropic Ingress** — Native Anthropic-format `/v1/messages` endpoint
|
|
114
|
+
- **Audit Logging** — Records every request/response with retention
|
|
115
|
+
- **Guardrails** — Content safety filters (system prompt, regex, PII redaction)
|
|
157
116
|
|
|
158
|
-
|
|
117
|
+
### Developer Experience
|
|
159
118
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
119
|
+
- **Zero-Config Startup** — Start immediately with auto-detected providers
|
|
120
|
+
- **Prometheus Metrics** — Go runtime + request metrics at `/metrics`
|
|
121
|
+
- **Swagger UI** — Interactive API docs at `/swagger/index.html`
|
|
122
|
+
- **SQLite Storage** — Zero-config embedded database, no setup needed
|
|
123
|
+
- **CLI Tools** — Admin configuration via CLI commands
|
|
163
124
|
|
|
164
|
-
|
|
165
|
-
rg -n --hidden -g '!node_modules' -g '!dashboard-ui/node_modules' -g '!*.png' -g '!*.jpg' -g '!*.lock' \
|
|
166
|
-
'(rediss://|postgres://[^[:space:]"'"'']+:[^[:space:]"'"'']+@|BEGIN (RSA |EC |OPENSSH |)PRIVATE KEY|[A-Z0-9_]*API_KEY\s*=\s*(sk-|gsk_|jina_|eyJ|[A-Za-z0-9_-]{20,}))'
|
|
125
|
+
---
|
|
167
126
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
127
|
+
## Repository Structure
|
|
128
|
+
|
|
129
|
+
Aurora uses a modular architecture for maximum flexibility:
|
|
130
|
+
|
|
131
|
+
```text
|
|
132
|
+
aurora/
|
|
133
|
+
├── apps/ # Application entrypoints
|
|
134
|
+
│ └── aurora/ # Main gateway binary
|
|
135
|
+
├── internal/ # Internal packages
|
|
136
|
+
│ ├── api/ # HTTP handlers, middleware
|
|
137
|
+
│ ├── config/ # Configuration loading and validation
|
|
138
|
+
│ ├── providers/ # Provider implementations (OpenAI, Anthropic, etc.)
|
|
139
|
+
│ ├── storage/ # SQLite, PostgreSQL, MongoDB backends
|
|
140
|
+
│ ├── guardrails/ # Content safety filters
|
|
141
|
+
│ ├── cache/ # Exact and semantic caching
|
|
142
|
+
│ └── analytics/ # Usage tracking and metrics
|
|
143
|
+
├── dashboard-ui/ # React admin dashboard frontend
|
|
144
|
+
├── configs/ # Configuration profiles and examples
|
|
145
|
+
├── docs/ # Documentation and assets
|
|
146
|
+
├── scripts/ # Build and release scripts
|
|
147
|
+
├── test/ # Test suites
|
|
148
|
+
└── helm/ # Kubernetes Helm charts
|
|
172
149
|
```
|
|
173
150
|
|
|
174
|
-
Expected result for the first command is no output, except intentionally kept public templates. Expected result for the secret search is only placeholders, dummy test keys, or documentation examples.
|
|
175
|
-
|
|
176
|
-
### If a secret was exposed
|
|
177
|
-
|
|
178
|
-
If a real key was committed locally, copied into a package artifact, or shared outside your machine, deleting the file is not enough. Revoke and rotate the credential at the provider, purge generated artifacts, and create the public GitHub repository from a clean tree with no inherited history.
|
|
179
|
-
|
|
180
151
|
---
|
|
181
152
|
|
|
182
153
|
## Providers
|
|
183
154
|
|
|
184
|
-
|
|
185
|
-
|---|---|:---:|:---:|:---:|:---:|:---:|
|
|
186
|
-
| OpenAI | `OPENAI_API_KEY` | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
187
|
-
| Anthropic | `ANTHROPIC_API_KEY` | ✅ | | | ✅ | ✅ |
|
|
188
|
-
| Google Gemini | `GEMINI_API_KEY` | ✅ | ✅ | ✅ | ✅ | |
|
|
189
|
-
| DeepSeek | `DEEPSEEK_API_KEY` | ✅ | | | | |
|
|
190
|
-
| Groq | `GROQ_API_KEY` | ✅ | ✅ | ✅ | ✅ | |
|
|
191
|
-
| OpenRouter | `OPENROUTER_API_KEY` | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
192
|
-
| Z.ai | `ZAI_API_KEY` | ✅ | ✅ | | | ✅ |
|
|
193
|
-
| xAI | `XAI_API_KEY` | ✅ | ✅ | ✅ | ✅ | |
|
|
194
|
-
| Azure OpenAI | `AZURE_API_KEY` + `AZURE_BASE_URL` | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
195
|
-
| Oracle | `ORACLE_API_KEY` + `ORACLE_BASE_URL` | ✅ | | | | |
|
|
196
|
-
| Ollama | `OLLAMA_BASE_URL` | ✅ | ✅ | | | |
|
|
197
|
-
| vLLM | `VLLM_BASE_URL` | ✅ | ✅ | | | ✅ |
|
|
198
|
-
|
|
199
|
-
> **Z.ai GLM Coding Plan:** set `ZAI_BASE_URL=https://api.z.ai/api/coding/paas/v4`
|
|
200
|
-
>
|
|
201
|
-
> **Multiple instances of one provider?** Use suffixed env vars: `OPENAI_EAST_API_KEY`, `OPENAI_EAST_BASE_URL`, `OPENAI_EAST_MODELS`
|
|
202
|
-
|
|
203
|
-
---
|
|
204
|
-
|
|
205
|
-
## Configuration
|
|
206
|
-
|
|
207
|
-
Aurora loads config in order: **defaults → YAML → env vars** (env vars win).
|
|
208
|
-
|
|
209
|
-
```bash
|
|
210
|
-
# Copy the env template for secrets/runtime values
|
|
211
|
-
cp .env.template .env
|
|
212
|
-
|
|
213
|
-
# Pick a config profile. Env vars in .env override YAML values.
|
|
214
|
-
export AURORA_CONFIG_PATH=configs/editions/oss.example.yaml
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
| Profile | Best for | External services |
|
|
218
|
-
|---|---|---|
|
|
219
|
-
| [`oss.example.yaml`](configs/editions/oss.example.yaml) | First run, individual devs | None |
|
|
220
|
-
| [`oss.local-power.example.yaml`](configs/editions/oss.local-power.example.yaml) | Local power users with audit, usage, metrics, exact cache, guardrail examples, token saver examples | Redis |
|
|
221
|
-
| [`oss.team.example.yaml`](configs/editions/oss.team.example.yaml) | Full OSS team profile with Postgres storage, Redis model/exact cache, semantic cache, provider examples, pools, fallback, resilience | PostgreSQL, Redis, Qdrant or another vector store |
|
|
222
|
-
|
|
223
|
-
**Key settings:**
|
|
224
|
-
|
|
225
|
-
| Setting | Default | What it does |
|
|
226
|
-
|---|---|---|
|
|
227
|
-
| `PORT` | `8080` | Listen port |
|
|
228
|
-
| `AURORA_MASTER_KEY` | -- | Gateway/admin API key (set before exposing outside localhost) |
|
|
229
|
-
| `STORAGE_TYPE` | `sqlite` | `sqlite`, `postgresql`, or `mongodb` |
|
|
230
|
-
| `LOGGING_ENABLED` | `false` | Audit logging |
|
|
231
|
-
| `METRICS_ENABLED` | `false` | Prometheus metrics |
|
|
232
|
-
| `GUARDRAILS_ENABLED` | `false` | Guardrail workflows |
|
|
233
|
-
| `ENABLE_PASSTHROUGH_ROUTES` | `true` | `/p/{provider}/...` passthrough |
|
|
234
|
-
| `TOKEN_SAVER_ENABLED` | `false` | Optional concise-output/token-saving transforms |
|
|
235
|
-
| `RESPONSE_CACHE_SIMPLE_ENABLED` | `false` unless configured in YAML | Redis exact response cache |
|
|
236
|
-
| `SEMANTIC_CACHE_ENABLED` | `false` unless configured in YAML | Embedding + vector-store semantic response cache |
|
|
237
|
-
|
|
238
|
-
Full reference: [`configs/config.example.yaml`](configs/config.example.yaml)
|
|
239
|
-
|
|
240
|
-
---
|
|
155
|
+
Providers are **auto-discovered from environment variables**. Set any of these keys in your `.env` and restart — the provider and its models appear automatically.
|
|
241
156
|
|
|
242
|
-
|
|
157
|
+
| Provider | Env var | Default models |
|
|
158
|
+
|----------|---------|----------------|
|
|
159
|
+
| OpenAI | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini` |
|
|
160
|
+
| Anthropic | `ANTHROPIC_API_KEY` | `claude-sonnet-4`, `claude-opus-4` |
|
|
161
|
+
| Google Gemini | `GEMINI_API_KEY` | `gemini-2.5-pro`, `gemini-2.5-flash` |
|
|
162
|
+
| Groq | `GROQ_API_KEY` | `llama-3.3-70b`, `qwen3-32b`, `whisper` |
|
|
163
|
+
| DeepSeek | `DEEPSEEK_API_KEY` | `deepseek-chat`, `deepseek-reasoner` |
|
|
164
|
+
| OpenRouter | `OPENROUTER_API_KEY` | 300+ models |
|
|
165
|
+
| xAI | `XAI_API_KEY` | `grok-3`, `grok-3-mini` |
|
|
166
|
+
| Z.ai | `ZAI_API_KEY` | `glm-4.5` |
|
|
167
|
+
| MiniMax | `MINIMAX_API_KEY` | `minimax-m1` |
|
|
168
|
+
| Azure OpenAI | `AZURE_API_KEY` + `AZURE_BASE_URL` | Your deployments |
|
|
169
|
+
| Oracle | `ORACLE_API_KEY` + `ORACLE_BASE_URL` | `cohere.command-r-plus` |
|
|
170
|
+
| Ollama | `OLLAMA_BASE_URL` | Any local model |
|
|
171
|
+
| vLLM | `VLLM_BASE_URL` | Any served model |
|
|
243
172
|
|
|
244
|
-
|
|
173
|
+
**Custom base URL?** Set `OPENAI_BASE_URL`, `GROQ_BASE_URL`, etc. in `.env`.
|
|
245
174
|
|
|
246
|
-
|
|
247
|
-
- **Semantic cache** -- embeds prompts, searches vector store for similar requests. Returns `X-Cache: HIT (semantic)`. Supports `qdrant`, `pgvector`, `pinecone`, `weaviate`.
|
|
248
|
-
|
|
249
|
-
Per-request bypass: `Cache-Control: no-cache` or `Cache-Control: no-store`.
|
|
175
|
+
**Multiple instances of the same provider?** Use suffix notation: `OPENAI_EAST_API_KEY`, `OPENAI_WEST_API_KEY`, etc.
|
|
250
176
|
|
|
251
177
|
---
|
|
252
178
|
|
|
253
|
-
##
|
|
254
|
-
|
|
255
|
-
```bash
|
|
256
|
-
# Infrastructure only (Redis, Qdrant, Postgres)
|
|
257
|
-
docker compose up -d
|
|
179
|
+
## Configuration
|
|
258
180
|
|
|
259
|
-
|
|
260
|
-
cp .env.template .env
|
|
261
|
-
docker compose --profile app up -d
|
|
181
|
+
The gateway loads settings in this order (later wins):
|
|
262
182
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
docker run --rm -p 8080:8080 --env-file .env aurora-oss
|
|
183
|
+
```
|
|
184
|
+
code defaults → config.yaml → .env / env vars
|
|
266
185
|
```
|
|
267
186
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
187
|
+
Generated by `aurora init`, every section is documented inline:
|
|
188
|
+
|
|
189
|
+
| Section | What it controls |
|
|
190
|
+
|---------|-----------------|
|
|
191
|
+
| `server` | Port, base path, master key, passthrough, Anthropic ingress |
|
|
192
|
+
| `admin` | Dashboard API and UI |
|
|
193
|
+
| `models` | Discovery, overrides, allowlisting |
|
|
194
|
+
| `storage` | SQLite (default), PostgreSQL, or MongoDB |
|
|
195
|
+
| `logging` | Audit logging of requests/responses |
|
|
196
|
+
| `usage` | Token tracking, pricing, retention |
|
|
197
|
+
| `metrics` | Prometheus endpoint |
|
|
198
|
+
| `guardrails` | Content safety filters |
|
|
199
|
+
| `cache` | Model cache, response cache (exact + semantic) |
|
|
200
|
+
| `combos` | Multi-model combo definitions |
|
|
201
|
+
| `token_saver` | Output compression |
|
|
202
|
+
| `fallback` | Provider failover rules |
|
|
203
|
+
| `resilience` | Retry + circuit breaker |
|
|
278
204
|
|
|
279
|
-
|
|
280
|
-
go build -o bin/aurora-oss.exe ./apps/aurora
|
|
205
|
+
---
|
|
281
206
|
|
|
282
|
-
|
|
283
|
-
.\scripts\release\build-editions.ps1 -Package
|
|
284
|
-
```
|
|
207
|
+
## Documentation
|
|
285
208
|
|
|
286
|
-
|
|
209
|
+
- [CLI Reference](https://github.com/aurorallm/aurora)
|
|
210
|
+
- [Provider Configuration](https://github.com/aurorallm/aurora)
|
|
211
|
+
- [Admin Dashboard](https://github.com/aurorallm/aurora)
|
|
212
|
+
- [Docker Compose & Helm](https://github.com/aurorallm/aurora)
|
|
287
213
|
|
|
288
|
-
|
|
214
|
+
## Need Help?
|
|
289
215
|
|
|
290
|
-
|
|
291
|
-
go test ./apps/... ./internal/...
|
|
292
|
-
pnpm --dir dashboard-ui run build
|
|
293
|
-
```
|
|
216
|
+
[Join our Discord](https://discord.com/invite/YJPrfR9uh) for community support, setup help, and discussions.
|
|
294
217
|
|
|
295
218
|
---
|
|
296
219
|
|
|
297
|
-
##
|
|
220
|
+
## Contributing
|
|
298
221
|
|
|
299
|
-
|
|
222
|
+
We welcome contributions of all kinds! Check out the repository to get started:
|
|
300
223
|
|
|
301
|
-
|
|
224
|
+
- Setting up the development environment
|
|
225
|
+
- Code conventions and best practices
|
|
226
|
+
- How to submit pull requests
|
|
227
|
+
- Building and testing locally
|
|
302
228
|
|
|
303
229
|
---
|
|
304
230
|
|
|
305
|
-
##
|
|
231
|
+
## License
|
|
306
232
|
|
|
307
|
-
|
|
308
|
-
|---|---|
|
|
309
|
-
| [Discord](https://discord.gg/YJPrfR9uh) | Deployment questions, provider setup, roadmap |
|
|
310
|
-
| [GitHub Issues](https://github.com/gurveeer/Aurora/issues) | Bug reports, feature requests |
|
|
311
|
-
| [GitHub Stars](https://github.com/gurveeer/Aurora/stargazers) | Support the project |
|
|
233
|
+
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
|
|
312
234
|
|
|
313
|
-
|
|
235
|
+
Built with ❤️ by the Aurora team.
|
package/bin/aurora.exe
CHANGED
|
Binary file
|
package/bin/aurora.js
CHANGED
package/config.yaml
CHANGED
package/package.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "1.0.
|
|
2
|
+
"version": "1.0.19",
|
|
3
3
|
"author": "SantiagoDePolonia",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"files": [
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"name": "iaurora",
|
|
24
24
|
"type": "module",
|
|
25
25
|
"bugs": {
|
|
26
|
-
"url": "https://github.com/
|
|
26
|
+
"url": "https://github.com/aurorallm/aurora/issues"
|
|
27
27
|
},
|
|
28
28
|
"description": "Aurora AI Gateway - one API for every LLM provider. Self-hosted, open-source.",
|
|
29
29
|
"engines": {
|
|
@@ -32,10 +32,10 @@
|
|
|
32
32
|
"scripts": {
|
|
33
33
|
"postinstall": "node ./scripts/npm-postinstall.js"
|
|
34
34
|
},
|
|
35
|
-
"homepage": "https://github.com/
|
|
35
|
+
"homepage": "https://github.com/aurorallm/aurora#readme",
|
|
36
36
|
"repository": {
|
|
37
37
|
"type": "git",
|
|
38
|
-
"url": "git+https://github.com/
|
|
38
|
+
"url": "git+https://github.com/aurorallm/aurora.git"
|
|
39
39
|
},
|
|
40
40
|
"bin": {
|
|
41
41
|
"aurora": "bin/aurora.js"
|
|
@@ -10,7 +10,7 @@ const __dirname = dirname(__filename);
|
|
|
10
10
|
const require = createRequire(import.meta.url);
|
|
11
11
|
const pkg = require(resolve(__dirname, '..', 'package.json'));
|
|
12
12
|
|
|
13
|
-
const GITHUB_REPO = '
|
|
13
|
+
const GITHUB_REPO = 'aurorallm/aurora';
|
|
14
14
|
const BINARY_DIR = join(os.homedir(), '.aurora', 'bin');
|
|
15
15
|
|
|
16
16
|
function platformAssetName() {
|