aboutsummaryrefslogtreecommitdiffstats
path: root/config/drive.ts
diff options
context:
space:
mode:
Diffstat (limited to 'config/drive.ts')
-rw-r--r--config/drive.ts149
1 files changed, 149 insertions, 0 deletions
diff --git a/config/drive.ts b/config/drive.ts
new file mode 100644
index 0000000..b6950eb
--- /dev/null
+++ b/config/drive.ts
@@ -0,0 +1,149 @@
1/**
2 * Config source: https://git.io/JBt3o
3 *
4 * Feel free to let us know via PR, if you find something broken in this config
5 * file.
6 */
7
8import Env from '@ioc:Adonis/Core/Env';
9import { driveConfig } from '@adonisjs/core/build/config';
10import Application from '@ioc:Adonis/Core/Application';
11
12/*
13|--------------------------------------------------------------------------
14| Drive Config
15|--------------------------------------------------------------------------
16|
17| The `DriveConfig` relies on the `DisksList` interface which is
18| defined inside the `contracts` directory.
19|
20*/
21export default driveConfig({
22 /*
23 |--------------------------------------------------------------------------
24 | Default disk
25 |--------------------------------------------------------------------------
26 |
27 | The default disk to use for managing file uploads. The value is driven by
28 | the `DRIVE_DISK` environment variable.
29 |
30 */
31 disk: Env.get('DRIVE_DISK', 'local'),
32
33 disks: {
34 /*
35 |--------------------------------------------------------------------------
36 | Local
37 |--------------------------------------------------------------------------
38 |
39 | Uses the local file system to manage files. Make sure to turn off serving
40 | files when not using this disk.
41 |
42 */
43 local: {
44 driver: 'local',
45 visibility: 'public',
46
47 /*
48 |--------------------------------------------------------------------------
49 | Storage root - Local driver only
50 |--------------------------------------------------------------------------
51 |
52 | Define an absolute path to the storage directory from where to read the
53 | files.
54 |
55 */
56 root: Application.tmpPath('uploads'),
57
58 /*
59 |--------------------------------------------------------------------------
60 | Serve files - Local driver only
61 |--------------------------------------------------------------------------
62 |
63 | When this is set to true, AdonisJS will configure a files server to serve
64 | files from the disk root. This is done to mimic the behavior of cloud
65 | storage services that has inbuilt capabilities to serve files.
66 |
67 */
68 serveFiles: true,
69
70 /*
71 |--------------------------------------------------------------------------
72 | Base path - Local driver only
73 |--------------------------------------------------------------------------
74 |
75 | Base path is always required when "serveFiles = true". Also make sure
76 | the `basePath` is unique across all the disks using "local" driver and
77 | you are not registering routes with this prefix.
78 |
79 */
80 basePath: '/uploads',
81 },
82
83 /*
84 |--------------------------------------------------------------------------
85 | S3 Driver
86 |--------------------------------------------------------------------------
87 |
88 | Uses the S3 cloud storage to manage files. Make sure to install the s3
89 | drive separately when using it.
90 |
91 |**************************************************************************
92 | npm i @adonisjs/drive-s3
93 |**************************************************************************
94 |
95 */
96 // s3: {
97 // driver: 's3',
98 // visibility: 'public',
99 // key: Env.get('S3_KEY'),
100 // secret: Env.get('S3_SECRET'),
101 // region: Env.get('S3_REGION'),
102 // bucket: Env.get('S3_BUCKET'),
103 // endpoint: Env.get('S3_ENDPOINT'),
104 //
105 // // For minio to work
106 // // forcePathStyle: true,
107 // },
108
109 /*
110 |--------------------------------------------------------------------------
111 | GCS Driver
112 |--------------------------------------------------------------------------
113 |
114 | Uses the Google cloud storage to manage files. Make sure to install the GCS
115 | drive separately when using it.
116 |
117 |**************************************************************************
118 | npm i @adonisjs/drive-gcs
119 |**************************************************************************
120 |
121 */
122 // gcs: {
123 // driver: 'gcs',
124 // visibility: 'public',
125 // keyFilename: Env.get('GCS_KEY_FILENAME'),
126 // bucket: Env.get('GCS_BUCKET'),
127
128 /*
129 |--------------------------------------------------------------------------
130 | Uniform ACL - Google cloud storage only
131 |--------------------------------------------------------------------------
132 |
133 | When using the Uniform ACL on the bucket, the "visibility" option is
134 | ignored. Since, the files ACL is managed by the google bucket policies
135 | directly.
136 |
137 |**************************************************************************
138 | Learn more: https://cloud.google.com/storage/docs/uniform-bucket-level-access
139 |**************************************************************************
140 |
141 | The following option just informs drive whether your bucket is using uniform
142 | ACL or not. The actual setting needs to be toggled within the Google cloud
143 | console.
144 |
145 */
146 // usingUniformAcl: false,
147 // },
148 },
149});