You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Managing Docker images, containers and networks from the command line while also trying to monitor crucial metrics can be tedious and counterintuitive. To make this process more developer-friendly, we created Docketeer: a container management platform for Docker.
32
29
30
+
Managing Docker images, containers and networks from the command line while also trying to monitor crucial metrics can be tedious and counterintuitive. To make this process more developer-friendly, we created Docketeer: a container management platform for Docker.
33
31
34
32
## Installation
33
+
35
34
1.**Fork** and **clone** this [repository](https://github.com/open-source-labs/Docketeer.git) to your machine.
2. Navigate to the project directory and install dependencies.
41
+
41
42
```
42
43
npm install
43
44
```
44
45
45
46
3. Create a `.env` file in the project's top-level directory.
47
+
46
48
```
47
49
root
48
50
├─ .env
@@ -51,18 +53,20 @@ root
51
53
```
52
54
53
55
4. In the .env file, configure the following environment variables for Twilio API, Slack Webhook, and Postgres URI. Refer to [Twilio](#-Twilio) setup section below. The Postgres URI is the only field that is required, others are optional. Create your own database to house user information and insert your URI in this file.
56
+
54
57
```js
55
58
// .env
56
-
TWILIO_NUMBER=''
57
-
TWILIO_ACCOUNT_SID=''
58
-
TWILIO_AUTH_TOKEN=''
59
-
SERVICE_SID=''
60
-
VERIFICATION_SERVICE_SID=''
61
-
SLACK_WEBHOOK=''
62
-
POSTGRES_URI=''
59
+
TWILIO_NUMBER="";
60
+
TWILIO_ACCOUNT_SID="";
61
+
TWILIO_AUTH_TOKEN="";
62
+
SERVICE_SID="";
63
+
VERIFICATION_SERVICE_SID="";
64
+
SLACK_WEBHOOK="";
65
+
POSTGRES_URI="";
63
66
```
64
67
65
68
5. Create a folder called `security` in the project's top-level directory. Inside of the `security` folder, create two files `email.js` and `sysadmin.js`. These files will store variables related to the email notification service and system admin setup respectively.
69
+
66
70
```
67
71
root
68
72
├─ security
@@ -72,143 +76,116 @@ root
72
76
└─ src
73
77
```
74
78
75
-
6. In the `email.js` file, input your organization's email credentials within the username and password properties. This email address will be used to send email notifications. The file is already in the `.gitignore` file.
76
-
Important: Do not change the host and port values unless you are using a different email provider.
79
+
6. In the `email.js` file, input your organization's email credentials within the username and password properties. This email address will be used to send email notifications. The file is already in the `.gitignore` file.
80
+
Important: Do not change the host and port values unless you are using a different email provider.
7. In the `sysadmin.js` file, input information for the system admin account. If no information is input, the email and phone number for the system admin will be set to default values. These values can always be changed in the system admin's Settings tab.
93
+
88
94
```js
89
95
// sysadmin.js
90
96
module.exports= {
91
-
phone:'',
92
-
email:'',
97
+
phone:"",
98
+
email:"",
93
99
};
94
100
```
95
101
96
102
You are all set! Now just enter the following command to start up Docketeer!
97
-
```
98
-
npm run dev
99
-
```
100
-
101
-
For now, the sign up function will create a System Admin user.
102
-
103
-
104
-
## Returning Users: Version Update
105
-
1. Navigate to the project directory and **add upstream** this [repository](https://github.com/open-source-labs/Docketeer.git) to your cloned fork.
4. You are all set! Now just enter the following command to start up Docketeer!
121
104
```
122
105
npm run dev
123
106
```
124
107
125
-
108
+
For now, the sign up function will create a System Admin user.
126
109
127
110
## Twilio setup
111
+
128
112
1. Follow documents found [here](https://www.twilio.com/docs/node/install) to download the helper library.
129
113
2. In order to manage Twilio SMS notifications follow the [step plan](https://www.twilio.com/docs/notify/quickstart/sms#messagingservice).
130
114
3. Store your (i) Twilio number, (ii) Account Sid, (iii) Auth Token from twilio.com/console, (iv) SERVICE_SID, (v) verification service SID in a newly created .env file in the Docketeer folder in the following format:
115
+
131
116
```js
132
117
// .env.js
133
-
MY_PHONE_NUMBER='your mobile number'
134
-
TWILIO_ACCOUNT_SID='code from your console'
135
-
TWILIO_AUTH_TOKEN='token from your console'
136
-
SERVICE_SID='code from notify service instance'
137
-
VERIFICATION_SERVICE_SID='code from verify service instance'
118
+
MY_PHONE_NUMBER="your mobile number";
119
+
TWILIO_ACCOUNT_SID="code from your console";
120
+
TWILIO_AUTH_TOKEN="token from your console";
121
+
SERVICE_SID="code from notify service instance";
122
+
VERIFICATION_SERVICE_SID="code from verify service instance";
138
123
```
139
124
140
125
4. Verification service was created [here](https://www.twilio.com/console/verify/services); code length and serviceSID can be taken from your Twilio account console.
141
126
5. All historical messages from the Twilio account can be found [here](https://www.twilio.com/console/sms/logs).
142
127
143
128
<!-- > Getting started with Docketeer is easy: visit [docketeer.org](https://www.docketeer.org/) and download the Docketeer desktop app. Drag and drop the .dmg file that you downloaded into your Applications folder to install it. Before you run the application, make sure Docker itself is running. -->
144
129
145
-
146
130
## Features
147
131
148
132
### ➮ System Wide Notifications
133
+
149
134
Docketeer offers monitoring support for teams by incorporating sms, email and slack notification as well as configurable options based on a container's memory or cpu usage.
150
135
151
-
### ➮ Viewing
152
-
You can view a list of running and exited containers, available images, volume history, and docker-compose files stored locally.
136
+
### ➮ Viewing
137
+
138
+
You can view a list of running and exited containers, available images, volume history, and docker-compose files stored locally.
153
139
154
140
### ➮ Live Metrics
141
+
155
142
Users have real-time access to the total amount of resources (CPU, memory usage) that your containers are using and total block IO bytes by image over specific time periods.
156
143
157
144
158
145
### ➮ Uploading
146
+
159
147
Within the Image and Docker Compose tab, you pull images from DockerHub by providing `repo:version` or uploading a `.yml` file.
160
148
161
149
### ➮ Process Logs
150
+
162
151
View process logs from any number of running or stopped containers. The table is both exportable and sortable by any parameter. You can filter logs by specifying the number of logs that you wish to receive (tail) as well as time (since). Process logs will help you analyze and debug problems faster by offering insights into what went wrong.
163
152
164
153
165
154
166
155
<br> For a full demo of Docketeer's features, visit [docketeer.org](https://www.docketeer.org/demo).
167
156
168
-
<!-- ## Development 🛠
157
+
<!-- ## Development 🛠
169
158
All ideas and contributions to the project are welcome. To run the app in development mode, clone our repo to your local machine and execute the following commands:
170
159
```
171
160
npm run dev
172
161
``` -->
173
162
174
-
175
163
## Testing
164
+
176
165
To conduct tests on the codebase, clone our repo to your local machine and execute the following commands in the terminal:
166
+
177
167
```
178
168
npm run test
179
169
```
180
170
181
171
## Troubleshoot
182
172
183
173
#### **Cannot connect to the Docker daemon**
174
+
184
175
⤷ Make sure that you have Docker running!
185
176
186
177
#### **Working with WSL**
187
-
⤷ Users may need to install a third-party App to run electron. A helpful article can be found [here](https://techcommunity.microsoft.com/t5/windows-dev-appconsult/running-wsl-gui-apps-on-windows-10/ba-p/1493242).
188
178
179
+
⤷ Users may need to install a third-party App to run electron. A helpful article can be found [here](https://techcommunity.microsoft.com/t5/windows-dev-appconsult/running-wsl-gui-apps-on-windows-10/ba-p/1493242).
189
180
190
181
## Contributing
182
+
191
183
Read our [contributing guide](https://github.com/open-source-labs/Docketeer/blob/master/CONTRIBUTING.md) for more information on how to purpose bugfixes and improvements to Docketeer.
192
184
193
185
### Authors
194
-
- Nathan Cho [@nathanycho](https://github.com/nathanycho) | [LinkedIn](https://www.linkedin.com/in/nathanycho/)
0 commit comments