Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
server
Manage
Activity
Members
Labels
Plan
Issues
25
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
1
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container Registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
cokoapps
server
Commits
815eefc5
Commit
815eefc5
authored
4 years ago
by
Yannis Barlas
Browse files
Options
Downloads
Patches
Plain Diff
docs(middleware): add auth docs to readme
parent
d0432f92
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+44
-1
44 additions, 1 deletion
README.md
with
44 additions
and
1 deletion
README.md
+
44
−
1
View file @
815eefc5
...
@@ -36,6 +36,49 @@ If you place this file in `server/app.js`, starting the server should work autom
...
@@ -36,6 +36,49 @@ If you place this file in `server/app.js`, starting the server should work autom
}
}
```
```
### Authorization middleware
The server provides authorization checks through using
`graphql-shield`
.
You can access all of shield's exports (eg.
`rule`
,
`and`
,
`or`
etc.) through
`@coko/server/authorization`
.
The only exception is
`shield`
, which is used internally by the server.
To get started, declare your permissions in any file you want:
```
js
// myPermissions.js
const
{
rule
}
=
require
(
'
@coko/server/authorization
'
)
const
permissions
=
{
Query
:
{
myQuery
:
rule
()(
async
(
parent
,
args
,
ctx
,
info
)
=>
{
// my auth logic here
}),
},
Mutation
:
{
myMutation
:
rule
()(
async
(
parent
,
args
,
ctx
,
info
)
=>
{
// my other auth logic here
}),
},
}
module
.
exports
=
permissions
```
For the server to access your permissions, simply add them to the config:
```
js
// config/default.js
const
permissions
=
require
(
'
../path/to/myPermissions.js
'
)
{
permissions
:
permissions
}
```
Please refer to shield's
[
documentation
](
https://github.com/maticzav/graphql-shield#overview
)
for more details.
### Cron support
### Cron support
All you need for cron-based scheduled tasks to run is to provide the path to your cron jobs.
All you need for cron-based scheduled tasks to run is to provide the path to your cron jobs.
...
@@ -85,5 +128,5 @@ If you run your client on a different host/port than the server, you might run i
...
@@ -85,5 +128,5 @@ If you run your client on a different host/port than the server, you might run i
### Future features
### Future features
-
Graphql
middleware
-
Notification
middleware
-
Include more pubsweet packages into the bundle
-
Include more pubsweet packages into the bundle
This diff is collapsed.
Click to expand it.
Preview
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment