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
Copy file name to clipboardExpand all lines: README.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,20 @@ It works as a client-server. The client spawns a server if one is not running al
11
11
12
12
Sccache can also be used with local storage instead of remote.
13
13
14
+
---
15
+
16
+
Table of Contents (ToC)
17
+
======================
18
+
19
+
*[Build Requirements](#build-requirements)
20
+
*[Build](#build)
21
+
*[Installation](#installation)
22
+
*[Usage](#usage)
23
+
*[Storage Options](#storage-options)
24
+
*[Debugging](#debugging)
25
+
*[Known Caveats](#known-caveats)
26
+
27
+
---
14
28
15
29
Build Requirements
16
30
------------------
@@ -27,6 +41,8 @@ We recommend you install Rust via [Rustup](https://rustup.rs/). The generated bi
27
41
28
42
> $ cargo install
29
43
44
+
---
45
+
30
46
Usage
31
47
-----
32
48
@@ -48,10 +64,12 @@ Running `sccache --show-stats` will print a summary of cache statistics.
48
64
49
65
Some notes about using `sccache` with [Jenkins](https://jenkins.io) are [here](docs/Jenkins.md).
50
66
67
+
---
68
+
51
69
Storage Options
52
70
---------------
53
71
54
-
Sccache defaults to using local disk storage. You can set the `SCCACHE_DIR` environment variable to change the disk cache location. By default it will use a sensible location for the current platform: `~/.cache/sccache` on Linux, `%LOCALAPPDATA%\Mozilla\sccache` on Windows, `~/Library/Caches/sccache` on OS X.
72
+
Sccache defaults to using local disk storage. You can set the `SCCACHE_DIR` environment variable to change the disk cache location. By default it will use a sensible location for the current platform: `~/.cache/sccache` on Linux, `%LOCALAPPDATA%\Mozilla\sccache` on Windows, and `~/Library/Caches/sccache` on OS X.
55
73
56
74
If you want to use S3 storage for the sccache cache, you need to set the `SCCACHE_BUCKET` environment variable to the name of the S3 bucket to use. You can use `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` to set the S3 credentials and if you need to override the default endpoint you can set `SCCACHE_ENDPOINT`. To connect to a minio storage for example you can set `SCCACHE_ENDPOINT=<ip>:<port>`.
57
75
@@ -63,6 +81,8 @@ By default, SCCACHE on GCS will be read-only. To change this, set `SCCACHE_GCS_R
63
81
64
82
*Important:* The environment variables are only taken into account when the server starts, so only on the first run.
65
83
84
+
---
85
+
66
86
Debugging
67
87
---------
68
88
@@ -72,6 +92,7 @@ Alternately, you can run the server manually in foreground mode by running `SCCA
72
92
73
93
You can set the `SCCACHE_ERROR_LOG` environment variable to a path to cause the server process to redirect its standard error output there, in order to capture the output of unhandled panics. (The server sets `RUST_BACKTRACE=1` internally.)
0 commit comments