Skip to content

Commit 16a786a

Browse files
committed
Update Usage.md and What's-new.md
1 parent ca89e5a commit 16a786a

File tree

2 files changed

+38
-8
lines changed

2 files changed

+38
-8
lines changed

doc/Usage.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
1-
The first time, you can run `google-drive-ocamlfuse` without parameters:
1+
First, you must [set up OAuth
2+
2.0](https://support.google.com/cloud/answer/6158849?hl=en):
23

3-
google-drive-ocamlfuse
4+
1. [Activate](https://cloud.google.com/service-usage/docs/enable-disable) the
5+
`Google Drive API`.
6+
1. Create an OAuth client ID.
7+
1. Choose `Desktop` as `Application type`.
8+
1. Set the `Name` to anything you like.
49

5-
This command will create the default application directory (`~/.gdfuse/default`), containing the configuration file `config` (see the [[Configuration]] page for more details about configuration). And it will start a web browser to obtain authorization to access your Google Drive. This will let you modify default configuration before mounting the filesystem.
10+
This way you will get a `Client ID` and `Client secret` that you can use to
11+
access your Drive. To authorize `google-drive-ocamlfuse`, pass the client ID
12+
and the client secret on the command line, e.g.:
613

7-
Then you can choose a local directory to mount your Google Drive (e.g.: `~/GoogleDrive`).
14+
google-drive-ocamlfuse -id xxxxxxxxxx.apps.googleusercontent.com -secret XXX-YYY-ZZZ
15+
16+
This command will create the default application directory
17+
(`~/.gdfuse/default`), containing the configuration file `config` (see the
18+
[wiki
19+
page](https://github.com/astrada/google-drive-ocamlfuse/wiki/Configuration)
20+
for more details about configuration). And it will start a web browser to
21+
obtain authorization to access your Google Drive. This way, you can modify the
22+
default configuration before mounting the filesystem.
23+
24+
Then, you can choose a local directory to mount your Google Drive (e.g.: `~/GoogleDrive`).
825

926
Create the mount point, if it doesn't exists:
1027

1128
mkdir ~/GoogleDrive
1229

13-
Then you can mount the filesystem:
30+
Then, you can mount the filesystem:
1431

1532
google-drive-ocamlfuse ~/GoogleDrive
1633

1734
If you have more than one account, you can run:
1835

19-
google-drive-ocamlfuse -label label [mountpoint]
36+
google-drive-ocamlfuse -label [label] ~/GoogleDrive
2037

21-
Using `label` to distinguish between different accounts. The program will use the directory `~/.gdfuse/label` to host configuration, application state, and file cache. No file is shared among different accounts, so you can have a different configuration for each one.
38+
Using `label` to distinguish different accounts. The program will use the
39+
directory `~/.gdfuse/[label]` to host the configuration, the application
40+
state, and the file cache. No file is shared among different accounts, so you
41+
can have a different configuration for each one.
2242

2343
To unmount the filesystem, issue this command:
2444

@@ -68,4 +88,10 @@ Run `google-drive-ocamlfuse -help` to get all the command options available. To
6888
* `-redirect_uri`: Specifies a custom `redirect_uri` for the OAuth2 [flow](https://developers.google.com/identity/protocols/OAuth2InstalledApp#step-2-send-a-request-to-googles-oauth-20-server)
6989

7090
#### Since 0.7.13
71-
* `-device`: Use [OAuth2 for Devices](https://github.com/astrada/google-drive-ocamlfuse/wiki/OAuth2-for-Devices) authorization flow
91+
* `-device`: Use [OAuth2 for Devices](https://github.com/astrada/google-drive-ocamlfuse/wiki/OAuth2-for-Devices) authorization flow
92+
93+
#### Since 0.7.32
94+
* `-port`: This option can be used to specify a port for the embedded HTTP
95+
server, that will receive the verification code from Google during
96+
authorization. The default is 8080.
97+

doc/What's-new.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
0.7.32
2+
======
3+
This version introduces a new command line option: `-port`, to specify a port for the embedded HTTP server, that will receive the verification code from Google during authorization. The default is 8080.
4+
15
0.7.21
26
======
37
This version introduces a new config option: `background_folder_fetching`. If set to a `true` (the default is `false`), it starts a thread to fetch folder data in background, so accessing folders should be faster.

0 commit comments

Comments
 (0)