mirror of
				https://github.com/Crazyco-xyz/48hr.email.git
				synced 2025-11-04 07:16:32 +01:00 
			
		
		
		
	clean up app.json and example config, also update README todo list
This commit is contained in:
		
							parent
							
								
									cca5ce7915
								
							
						
					
					
						commit
						dc7d7e6676
					
				
					 4 changed files with 44 additions and 22 deletions
				
			
		
							
								
								
									
										14
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
					@ -95,13 +95,15 @@ WantedBy=multi-user.target
 | 
				
			||||||
<br><br>
 | 
					<br><br>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-----
 | 
					-----
 | 
				
			||||||
### TODO:
 | 
					### TODO (PRs welcome):
 | 
				
			||||||
- Clean up codebase
 | 
					- Clean up code inside application folder
 | 
				
			||||||
 | 
					- Add user registration:
 | 
				
			||||||
 | 
					    - Optional "premium" domains that arent visible to the public to prevent them from being scraped and flagged
 | 
				
			||||||
 | 
					    - Allow people to set a password for their email (releases X time after last login)
 | 
				
			||||||
 | 
					    - Allow people to set up forwarding 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#### Maybe later (PRs welcome):
 | 
					#### Unsure:
 | 
				
			||||||
- Allow users to set a password for their email
 | 
					- Possible payment integration once registration exists, to lock one or more of these new features behind a paywall (configurable, ofc)
 | 
				
			||||||
- Set up forwarding
 | 
					 | 
				
			||||||
- Sending emails
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
<br><br>
 | 
					<br><br>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										42
									
								
								app.json
									
										
									
									
									
								
							
							
						
						
									
										42
									
								
								app.json
									
										
									
									
									
								
							| 
						 | 
					@ -1,18 +1,19 @@
 | 
				
			||||||
{
 | 
					{
 | 
				
			||||||
  "name": "48hr.email | disposable email",
 | 
					  "name": "48hr.email | Disposable email",
 | 
				
			||||||
  "description": "a simple and fast disposable mail service that works directly with your imap server. No database required.",
 | 
					  "description": "A simple and fast disposable mail service that works directly with your already existing imap server. No database required.",
 | 
				
			||||||
  "repository": "https://github.com/Crazyco-xyz/48hr.email",
 | 
					  "repository": "https://github.com/Crazyco-xyz/48hr.email",
 | 
				
			||||||
  "logo": "https://github.com/Crazyco-xyz/48hr.email/blobl/main/infrastructure/web/public/images/logo.png",
 | 
					  "logo": "https://github.com/Crazyco-xyz/48hr.email/blob/main/infrastructure/web/public/images/logo.png",
 | 
				
			||||||
  "keywords": [
 | 
					  "keywords": [
 | 
				
			||||||
    "node",
 | 
					    "node",
 | 
				
			||||||
    "disposable-mail"
 | 
					    "disposable-mail"
 | 
				
			||||||
  ],
 | 
					  ],
 | 
				
			||||||
  "env": {
 | 
					  "env": {
 | 
				
			||||||
    "DOMAINS": {
 | 
					    "DOMAINS": {
 | 
				
			||||||
      "description": "Email domains."
 | 
					      "description": "Email domains"
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "IMAP_SERVER": {
 | 
					    "DELETE_MAILS_OLDER_THAN_DAYS": {
 | 
				
			||||||
      "description": "Hostname of the server (usually imap.example.com)"
 | 
					      "description": "How many days to to wait before deleting messages",
 | 
				
			||||||
 | 
					      "value": 2
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "IMAP_USER": {
 | 
					    "IMAP_USER": {
 | 
				
			||||||
      "description": "Username to login to the imap server"
 | 
					      "description": "Username to login to the imap server"
 | 
				
			||||||
| 
						 | 
					@ -20,11 +21,32 @@
 | 
				
			||||||
    "IMAP_PASSWORD": {
 | 
					    "IMAP_PASSWORD": {
 | 
				
			||||||
      "description": "Password to login to the imap server"
 | 
					      "description": "Password to login to the imap server"
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "IMAP_REFRESH_INTERVAL_SECONDS": {
 | 
					    "IMAP_SERVER": {
 | 
				
			||||||
      "description": "How often to refresh the imap messages manually"
 | 
					      "description": "Hostname of the server (usually imap.example.com or mx.example.com)"
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "DELETE_MAILS_OLDER_THAN_DAYS": {
 | 
					    "IMAP_PORT": {
 | 
				
			||||||
      "description": "How many days to to wait before deleting messages."
 | 
					      "description": "Port of the server (usually 993)",
 | 
				
			||||||
 | 
					      "value": 993
 | 
				
			||||||
 | 
					    },
 | 
				
			||||||
 | 
					    "IMAP_TLS": {
 | 
				
			||||||
 | 
					      "description": "Use tls or not",
 | 
				
			||||||
 | 
					      "value": true
 | 
				
			||||||
 | 
					    },
 | 
				
			||||||
 | 
					    "IMAP_AUTHTIMEOUT": {
 | 
				
			||||||
 | 
					      "description": "Timeout for the auth",
 | 
				
			||||||
 | 
					      "value": 3000
 | 
				
			||||||
 | 
					    },
 | 
				
			||||||
 | 
					    "IMAP_REFRESH_INTERVAL_SECONDS": {
 | 
				
			||||||
 | 
					      "description": "How often to refresh the imap messages manually",
 | 
				
			||||||
 | 
					      "value": 60
 | 
				
			||||||
 | 
					    },
 | 
				
			||||||
 | 
					    "HTTP_PORT": {
 | 
				
			||||||
 | 
					      "description": "Port to listen on",
 | 
				
			||||||
 | 
					      "value": 3000
 | 
				
			||||||
 | 
					    },
 | 
				
			||||||
 | 
					    "HTTP_BRANDING": {
 | 
				
			||||||
 | 
					      "description": "The branding of the site",
 | 
				
			||||||
 | 
					      "value": ["48hr.email", "Crazyco", "https://crazyco.xyz"]
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
  }
 | 
					  }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,5 +1,3 @@
 | 
				
			||||||
// Note: Also update app.json and README.md!
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
const config = {
 | 
					const config = {
 | 
				
			||||||
	email: {
 | 
						email: {
 | 
				
			||||||
		domains: process.env.EMAIL_DOMAINS,
 | 
							domains: process.env.EMAIL_DOMAINS,
 | 
				
			||||||
| 
						 | 
					@ -12,10 +10,10 @@ const config = {
 | 
				
			||||||
		port: process.env.IMAP_PORT || 993,
 | 
							port: process.env.IMAP_PORT || 993,
 | 
				
			||||||
		tls: process.env.IMAP_TLS || true,
 | 
							tls: process.env.IMAP_TLS || true,
 | 
				
			||||||
		authTimeout: process.env.IMAP_AUTHTIMEOUT || 3000,
 | 
							authTimeout: process.env.IMAP_AUTHTIMEOUT || 3000,
 | 
				
			||||||
		refreshIntervalSeconds: process.env.IMAP_REFRESH_INTERVAL_SECONDS || 10
 | 
							refreshIntervalSeconds: process.env.IMAP_REFRESH_INTERVAL_SECONDS || 60
 | 
				
			||||||
	},
 | 
						},
 | 
				
			||||||
	http: {
 | 
						http: {
 | 
				
			||||||
		port: normalizePort(process.env.HTTP_PORT || '3000'),
 | 
							port: normalizePort(process.env.HTTP_PORT || 3000),
 | 
				
			||||||
		branding: process.env.HTTP_BRANDING || ["48hr.email", "CrazyCo", "https://crazyco.xyz"]
 | 
							branding: process.env.HTTP_BRANDING || ["48hr.email", "CrazyCo", "https://crazyco.xyz"]
 | 
				
			||||||
	},
 | 
						},
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
| 
						 | 
					@ -48,4 +46,4 @@ function normalizePort(val) {
 | 
				
			||||||
	return false
 | 
						return false
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
module.exports = config;
 | 
					module.exports = config;
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,6 +1,6 @@
 | 
				
			||||||
{
 | 
					{
 | 
				
			||||||
  "name": "48hr.email",
 | 
					  "name": "48hr.email",
 | 
				
			||||||
  "version": "1.5.2",
 | 
					  "version": "1.5.3",
 | 
				
			||||||
  "private": false,
 | 
					  "private": false,
 | 
				
			||||||
  "scripts": {
 | 
					  "scripts": {
 | 
				
			||||||
    "start": "node --trace-warnings ./app.js",
 | 
					    "start": "node --trace-warnings ./app.js",
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		
		Reference in a new issue