Skip to content

Commit 3dea89a

Browse files
authored
Add S3 use documentation and other (#335)
* one commit * two commit * add S3 Docs * update side * add Doge OSS * fix 115 mermaid
1 parent 7b354bb commit 3dea89a

File tree

26 files changed

+372
-56
lines changed

26 files changed

+372
-56
lines changed
21.8 KB
Loading
11.6 KB
Loading
181 KB
Loading
12.3 KB
Loading
91.6 KB
Loading

docs/.vuepress/theme.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export default hopeTheme(
130130
// card: true,
131131
},
132132
components: {
133-
components: ["ArtPlayer", "BiliBili", "Badge","VPCard"],
133+
components: ["ArtPlayer", "BiliBili", "Badge","VPCard","Replit"],
134134
// 临时弹窗
135135
rootComponents: {
136136
notice: [

docs/config/configuration.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,11 @@ After modifying the configuration file, restart AList for changes to take effect
107107
"allow_headers": [
108108
"*"
109109
]
110+
},
111+
"s3": {
112+
"enable": false,
113+
"port": 5246,
114+
"ssl": false
110115
}
111116
}
112117
```
@@ -443,3 +448,23 @@ Configuration for Cross-Origin Resource Sharing (CORS).
443448
- **allow_headers**: Allowed request headers.
444449

445450
Use it to understand it by yourself, and then configure it. If you do n’t know, please do n’t modify it at will. Use the default configuration.
451+
452+
<br/>
453+
454+
455+
456+
### **S3**
457+
458+
```json
459+
"s3": {
460+
"enable": false,
461+
"port": 5246,
462+
"ssl": false
463+
}
464+
```
465+
466+
- `enable`:Whether the S3 function is enabled, the default is not enabled
467+
- `port`:port
468+
- `SSL`:Enable the HTTPS certificate, not enabled by default
469+
470+
Function introduction: [Click to view](../guide/advanced/s3.md)

docs/config/side.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ After the expand
4040

4141
Let me briefly introduce it, probably, the functions that are often used
4242

43+
::: tip
44+
45+
If you didn't find this feature, please update the version
46+
47+
:::
48+
4349
1. **Refresh**:The refresh we mentioned is not to use F5 to refresh the webpage, **but use** <span style="color: rgb(24, 144, 255);"><svg fill="currentColor" stroke-width="0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="hope-icon hope-c-XNyZK hope-c-PJLV hope-c-PJLV-ifkxHPo-css" tips="refresh" height="1em" width="1em" style="overflow: visible;"><path fill="none" d="M0 0h24v24H0z"></path><path d="M5.463 4.433A9.961 9.961 0 0112 2c5.523 0 10 4.477 10 10 0 2.136-.67 4.116-1.81 5.74L17 12h3A8 8 0 006.46 6.228l-.997-1.795zm13.074 15.134A9.961 9.961 0 0112 22C6.477 22 2 17.523 2 12c0-2.136.67-4.116 1.81-5.74L7 12H4a8 8 0 0013.54 5.772l.997 1.795z"></path></svg></span> **to refresh**, so that the files that just uploaded to the network disk can be refreshed out
4450

4551

@@ -112,35 +118,41 @@ Let me briefly introduce it, probably, the functions that are often used
112118
113119

114120
6. **Grid item size** :Adjust the picture size in the Grid item mode
121+
115122

116-
117-
123+
118124
7. **List item filename overflow**:When the text is too long, the three state selection
119-
125+
120126
- **Ellipsis**(default)
121-
127+
122128
- **Scrollable** (PC users use the `shift`+` mousewheel `on the file, if it is a mobile phone user sliding the file left and right)
123-
129+
124130
- **Multi-line**
131+
125132

126-
127-
133+
128134
8. **Open item on Checkbox**
129-
135+
130136
- Direct (Open the file/enter the folder)
131-
137+
138+
- Disable while checked
139+
132140
- With `Ctrl or Command` hold
133-
141+
134142
- With `Alt or Option` hold
135143
- `Ctrl``Alt` is Windows
136144
- `command``Option` is Mac
137145
- If the button option does not take effect, please check whether the browser plugin conflict :point_right: [Case](https://github.com/alist-org/alist-web/pull/154#issuecomment-1972681627)
138-
146+
139147
<i class="fa-solid fa-lightbulb fa-bounce" style="color: green;"></i> Tips:You can press the `Shift` key to select one, and then select one end. You can quickly select all the files in the middle
140-
141-
142-
143-
9. **Language package selection** and **night mode and daytime mode switch**
148+
149+
9. **Select item with mouse while checkbox closed**
150+
- The default disable: You can click the mouse to open the file
151+
- D double -click: You can use the mouse box to select multiple files, or you can use the button `ctrl` to select multiple files
152+
153+
![](/img/config/side/side_10.png)
154+
155+
10. **Language package selection** and **night mode and daytime mode switch**
144156

145157

146158

docs/config/style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The home icon is displayed in the left of the navigation bar. The default is `
4747
### **Home container**
4848

4949
- Max 980px: the main width will set to `min(99%, 980px)`
50-
- Hope container: sets the max-width of the content to match the min-width of the current breakpoint, refer to https://hope-ui.com/docs/layout/container .
50+
- Hope container: sets the max-width of the content to match the min-width of the current breakpoint, refer to https://hope-ui.com/docs/layout/container
5151

5252

5353

docs/guide/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ A file list program that supports multiple storage, and supports web browsing an
3636
- [x] SFTP
3737
- [x] [PikPak / share](https://www.mypikpak.com/)
3838
- [x] [S3](../guide/drivers/s3.md)
39+
- [x] [Doge](../guide/drivers/s3.md#add-object-storage-examples-and-official-documents)
3940
- [x] [UPYUN Storage Service](https://www.upyun.com/products/file-storage)
4041
- [x] WebDAV
4142
- [x] Teambition([China](https://www.teambition.com/)[International](https://us.teambition.com/)

0 commit comments

Comments
 (0)