@@ -5,6 +5,47 @@ about a week.
5
5
6
6
This program connects to your email account via IMAP and fetches the last 100 emails and then checks if they are from
7
7
Kleinanzeigen.
8
- It then simply calls the URL in the email to renew the ad and move the email to another folder in your email account.
8
+ It then simply calls the URL in the email to renew the ad and move the email to another folder in your email account
9
+ depending on if they success or not.
9
10
10
- ** The installation instructions are coming soon**
11
+ ## Installation
12
+
13
+ The easiest way to set up the application is to use Docker and docker-compose.
14
+ Just save the file below as `` docker-compose.yml `` and run `` docker-compose up -d `` to run the application in the
15
+ background.
16
+ It's recommended to run it on a server so that it can periodically check for new mail.
17
+ I can recommend using Portainer to manage your Docker containers, you just need to paste the file below into a stack and
18
+ run it. That's it.
19
+
20
+ But before you start the application, you need to set up the credentials to access your mail account.
21
+ It's possible to use several mail accounts.
22
+
23
+ ### Gmail
24
+
25
+ For Gmail, you need to create an application password to use the application if you have two-factor authentication
26
+ enabled.
27
+ Simply visit [ this page] ( https://myaccount.google.com/apppasswords ) to create the application password.
28
+
29
+ The hostname for Gmail is `` imap.gmail.com ``
30
+
31
+ ### iCloud
32
+
33
+ With iCloud, you also need to create an application password [ here] ( https://account.apple.com/account/manage ) to sign
34
+ in.
35
+
36
+ The host name for iCloud is: `` imap.mail.me.com ``
37
+
38
+ ``` yaml
39
+ services :
40
+ app :
41
+ image : ghcr.io/tutorialwork/kleinanzeigen-ads-renewer:1.0.0
42
+ environment :
43
+ - IMAP_SERVERS_GMAIL_HOST=imap.gmail.com
44
+ - IMAP_SERVERS_GMAIL_USERNAME=YOUR_GMAIL_EMAIL
45
+ - IMAP_SERVERS_GMAIL_PASSWORD=YOUR_GMAIL_APP_PASSWORD
46
+ - IMAP_SERVERS_ICLOUD_HOST=imap.mail.me.com
47
+ - IMAP_SERVERS_ICLOUD_USERNAME=YOUR_ICLOUD_EMAIL
48
+ - IMAP_SERVERS_ICLOUD_PASSWORD=YOUR_ICLOUD_APP_PASSWORD
49
+ - IMAP_FOLDERS_PROCESSED_FOLDER_NAME=Kleinanzeigen Mails # Optional, name of the folder where the mails get moved after successfully renewing the ad
50
+ - IMAP_FOLDERS_FAILED_FOLDER_NAME=Kleinanzeigen Failed Mails # Optional, name of the folder where the mails get moved after the renewing failed 3 times
51
+ ` ` `
0 commit comments