overleaf/services/notifications/README.md

overleaf/notifications
===============

An API for managing user notifications in Overleaf


database indexes
================

For notification expiry to work, a TTL index on `notifications.expires` must be created:

```javascript
db.notifications.createIndex({expires: 1}, {expireAfterSeconds: 10})
```

License
=======
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3.

Copyright (c) Overleaf, 2016–2019.
-												Update README.md
											
										
										
											2019-05-07 11:23:20 -04:00
+								overleaf/notifications
-												create scaffolding base on tags repo

											
										
										
											2016-01-14 07:35:16 -05:00
+								===============
-												Update README.md
											
										
										
											2019-05-07 11:23:20 -04:00
+								An API for managing user notifications in Overleaf
-												Add commentary on ttl index

											
										
										
											2016-08-11 07:03:50 -04:00
 								database indexes
 								================
-												Change how notification expiry works

Set the `expires` field to be a date in the future, after which the
document should be removed.

											
										
										
											2016-08-12 06:38:17 -04:00
+								For notification expiry to work, a TTL index on `notifications.expires` must be created:
-												Add commentary on ttl index

											
										
										
											2016-08-11 07:03:50 -04:00
 								```javascript
-												Change how notification expiry works

Set the `expires` field to be a date in the future, after which the
document should be removed.

											
										
										
											2016-08-12 06:38:17 -04:00
+								db.notifications.createIndex({expires: 1}, {expireAfterSeconds: 10})
-												Add commentary on ttl index

											
										
										
											2016-08-11 07:03:50 -04:00
+								```
-												Add missing license statement
											
										
										
											2019-05-09 07:03:27 -04:00
 								License
 								=======
 								The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3.
 								Copyright (c) Overleaf, 2016–2019.