Skip to content

Commit bba8cb5

Browse files
committed
Update Quick Start in index.html
1 parent e66c083 commit bba8cb5

1 file changed

Lines changed: 14 additions & 21 deletions

File tree

index.html

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -81,42 +81,35 @@ <h2>Community</h2>
8181

8282
<section id="quick-start">
8383
<h2>Quick Start</h2>
84-
<p>Embulk runs on Java. Make sure Java Runtime is installed.</p>
85-
<p>Embulk v0.9 (past stable) run only on Java 8.</p>
86-
<p>Embulk v0.11 officially supports only Java 8, but expected to work somehow with Java 11, and 17. We are going to test v0.11 with Java 11 and 17 so that we can declare an official support for them.</p>
8784

88-
<h3>Linux &amp; macOS</h3>
89-
<pre><code>curl --create-dirs -o ~/.embulk/bin/embulk -L "https://dl.embulk.org/embulk-latest.jar"
90-
chmod +x ~/.embulk/bin/embulk
91-
echo 'export PATH="$HOME/.embulk/bin:$PATH"' &gt;&gt; ~/.bashrc
92-
source ~/.bashrc</code></pre>
85+
<p>Set up the Java Runtime Environment. Embulk runs on Java. Embulk v0.11 officially supports only Java 8, but expected to work somehow with Java 11, 17, and 21.</p>
86+
<p>Download the latest `embulk-X.Y.Z.jar` from: [GitHub Releases](https://github.com/embulk/embulk/releases)</p>
9387

94-
<h3>Windows</h3>
95-
<pre><code>PowerShell -Command "&amp; {[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::TLS12; Invoke-WebRequest http://dl.embulk.org/embulk-latest.jar -OutFile embulk.bat}"</code></pre>
88+
<p>Try the following commands. <code>embulk example</code> command generates an example CSV file.</p>
89+
<pre><code>java -jar embulk-X.Y.Z.jar example ./try1
90+
java -jar embulk-X.Y.Z.jar guess ./try1/seed.yml -o config.yml
91+
java -jar embulk-X.Y.Z.jar preview config.yml
92+
java -jar embulk-X.Y.Z.jar run config.yml</code></pre>
93+
94+
<h3>Install an Embulk plugin</h3>
95+
96+
<p>Install an Embulk plugin (ex. S3 Input Plugin) with the following command.</p>
97+
<pre><code>java -jar embulk-X.Y.Z.jar install "org.embulk:embulk-input-s3:0.6.0"</code></pre>
9698

9799
<h3>Set up with JRuby</h3>
100+
101+
<p>If you need to use a RubyGems-style Embulk plugin, you'll have to set up with JRuby.</p>
98102
<p>Download your preferred version 9.x.y of JRuby Complete jar from <a href="https://www.jruby.org/download">JRuby Downloads</a>, and put it in your favorite directory.</p>
99103
<p>Embulk is tested with old JRuby 9.1.15.0 as of now. (However, older JRuby has an <a href="articles/2023/07/28/embulk-gem-install-in-v0_9-series-sometime-fails.html">issue in installing Ruby gems</a>. You may need to try newer JRuby.)</p>
100104

101-
102105
<p>Then, create <code>~/.embulk/embulk.properties</code> as follows.</p>
103106
<pre><code>jruby=file:///path/to/jruby-complete-9.x.y.z.jar</code></pre>
104107

105108
<p>Finally, install some Ruby gems.</p>
106-
107109
<pre><code>embulk gem install embulk -v {{ site.embulk_version }} # Must be the same Embulk version
108110
embulk gem install msgpack
109111
embulk gem install bundler # if you need Bundler
110112
embulk gem install liquid # if you need Liquid</code></pre>
111-
112-
<h3>Next steps</h3>
113-
<p>The <code>embulk example</code> command generates an example CSV file.</p>
114-
<p>You can try Embulk quickly by:</p>
115-
<pre><code>embulk example ./try1
116-
embulk guess ./try1/seed.yml -o config.yml
117-
embulk preview config.yml
118-
embulk run config.yml
119-
</code></pre>
120113
</section>
121114

122115
<section id="presentation">

0 commit comments

Comments
 (0)